The API is pull; the webhook is push. Use it to sync CRM, Inbox, and metrics without polling.
In short
- Every delivery is a POST
application/json to the registered URL.
chat.* events are in-app chat only. WhatsApp uses message.*, push uses push.*.
instanceId is empty (chat has no channel instance).
- Enable only the events your integration uses.
- Reply 2xx quickly; heavy work goes to your queue.
Register a webhook and enable the chat.* events you need. Chat always fires if the webhook is subscribed — there is no extra “inbound messages” switch on the channel. General setup: Webhooks. HMAC: Webhook security.
POST body
Headers: X-Notifique-Signature, X-Notifique-Timestamp, X-Workspace-Id, X-Webhook-Event.
2xx within ~10s succeeds; 4xx / 5xx / timeout retries (5 min, 30 min, 2 h).
Events
USER → chat.received. AGENT → chat.sent. chat.conversation.updated also fires when the room capability switch changes.
Next steps