Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): list the missing webhook idempotency key derivations

Yudhi Armyndharisac33d05c6c7f
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index a30edd224..2c68f6e6e 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -7159,8 +7159,12 @@ Every delivery includes:
- `group.update`: `grp_{groupId}_update_{hash(changes)}_{occurredAt}`
- `group.join_request`: `grp_{groupId}_{hash(participantIds)}_join_request_{occurredAt}` (salted like `group.join` — a rejected user can legitimately ask again)
- `call.received`: `call_{sessionId}_{callId}` (a call id is unique per call, so no `occurredAt` salt)
+- `call.accepted` / `call.rejected` / `call.missed`: `call_{sessionId}_{callId}_{outcome}` (each call ends once, so no `occurredAt` salt)
+- `session.restriction`: `restr_{sessionId}_{kind}_{active}_{occurredAt}`
+- `presence.update`: `pres_{sessionId}_{chatId}_{occurredAt}`
+- any other event (for example `status.received`): `evt_{event with . replaced by _}_{hash(data)}`
-Recurring lifecycle events (and `message.reaction` / `message.edited`) carry the same content across occurrences — the same phone on every reconnect, a constant disconnect reason, a re-applied emoji, or editing the same message multiple times — so they are salted with an `occurredAt` timestamp captured **once per dispatch and reused across that dispatch's retries**. This gives distinct occurrences distinct keys while keeping retries of one occurrence stable. Message keys are scoped by `sessionId` because WhatsApp message ids are unique per account, not globally.
+Recurring lifecycle events (and `message.reaction` / `message.edited` / `presence.update`) carry the same content across occurrences — the same phone on every reconnect, a constant disconnect reason, a re-applied emoji, or editing the same message multiple times — so they are salted with an `occurredAt` timestamp captured **once per dispatch and reused across that dispatch's retries**. This gives distinct occurrences distinct keys while keeping retries of one occurrence stable. Message keys are scoped by `sessionId` because WhatsApp message ids are unique per account, not globally.
### Retries with exponential backoff