Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): state the resolution and merge limits of event.response

Yudhi Armyndharisf0c6911c835a
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index 4ce0f75e5..b59b3f99a 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -7257,9 +7257,9 @@ These are the events OpenWA actually emits. A webhook is registered with an `eve
> }
> ```
>
-> `response` is one of `going`, `not_going`, `maybe` or `unknown`. A guest who changes their answer sends a new RSVP with a new `responseMessageId`, so the event with the latest `timestamp` per `responderId` is the current answer. Order by `timestamp` rather than by arrival: delivery order is not guaranteed (see the offline note below). `extraGuestCount` is present only when WhatsApp sends it, and `eventName` only when the event's creation message can still be read from the message store. `contact` names the responder like `message.received` names its sender: `name` from the account's addressbook, `pushName` from their own profile, each present only when known, and the whole field absent when neither is. It is read from the contacts the session already holds, with no WhatsApp lookup per answer, so a responder the session knows nothing about yet arrives without one. Webhook `filters` define no fields for this event, so a webhook's conditions do not narrow it: scope RSVPs to a chat by checking `chatId` on receipt.
+> `response` is one of `going`, `not_going`, `maybe` or `unknown`. A guest who changes their answer sends a new RSVP with a new `responseMessageId`, so the event with the latest `timestamp` per `responderId` is the current answer. Order by `timestamp` rather than by arrival: delivery order is not guaranteed (see the note below). `timestamp` has one-second resolution, so two answers of one guest inside the same second cannot be told apart by it. `extraGuestCount` is present only when WhatsApp sends it, and `eventName` only when the event's creation message can still be read from the message store; it is the name the event was created with, and a later rename is not reflected. `contact` names the responder like `message.received` names its sender: `name` from the account's addressbook, `pushName` from their own profile, each present only when known, and the whole field absent when neither is. It is read from the contacts the session already holds, with no WhatsApp lookup per answer, so a responder the session knows nothing about yet arrives without one. Webhook `filters` define no fields for this event, so a webhook's conditions do not narrow it: scope RSVPs to a chat by checking `chatId` on receipt.
>
-> WhatsApp encrypts every RSVP with a key derived from the event creation message, so only answers to events **this session received and still holds in its message store** can be reported: an event posted before the number was linked, or one evicted past `BAILEYS_MESSAGE_STORE_LIMIT`, yields no `event.response`. This covers events in groups and in 1:1 chats, with one known gap: in a 1:1 chat, an answer from the person who posted the event, whether the other person or this account answering its own event, cannot be decrypted (Baileys derives the event's creator from the chat partner's side of the chat) and is not reported. Answers given while the session was offline are reported when WhatsApp replays them on reconnect, but Baileys merges the replayed updates per event, so several answers to one event given while offline, even from different guests, arrive as the last one only. whatsapp-web.js accepts the subscription and never fires the event.
+> WhatsApp encrypts every RSVP with a key derived from the event creation message, so only answers to events **this session received and still holds in its message store** can be reported: an event posted before the number was linked, or one evicted past `BAILEYS_MESSAGE_STORE_LIMIT`, yields no `event.response`. This covers events in groups and in 1:1 chats, with one known gap: in a 1:1 chat, an answer from the person who posted the event, whether the other person or this account answering its own event, cannot be decrypted (Baileys derives the event's creator from the chat partner's side of the chat) and is not reported. Answers given while the session was offline are reported when WhatsApp replays them on reconnect. Baileys merges the updates it receives within one short buffer window per event, so several answers to one event that arrive in the same window, even from different guests (the whole replay after a reconnect, or answers a fraction of a second apart live), arrive as the last one only. whatsapp-web.js accepts the subscription and never fires the event.
> There is **no** `contact.update` event. `presence.update` is emitted only for chats you have subscribed to (see the presence-subscription endpoint); call outcomes are reported as `call.accepted`, `call.rejected` and `call.missed` alongside `call.received`.