Webhooks

Message Acknowledgement

Track message delivery and read status (sent, delivered, read).

Best practices

  • Use this to update message status icons in your custom chat UI.

  • Track performance by measuring the time between 'Sent' and 'Read' acknowledgements.

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Webhook Payload Example
application/json
string *
number *
string *
object *
string *
string *
object *
object *

Example

{
"id": "evt_01...",
"timestamp": 1634567890123,
"session": "default",
"metadata": {
  "user.id": "123",
  "user.email": "email@example.com"
  },
"engine": "WEBJS",
"event": "message.ack",
"payload": {
  "id": "true_11111111111@c.us_...",
  "ack": 3,
  "ackName": "READ",
  "chatId": "11111111111@c.us"
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123@lid",
  "pushName": "Instance"
  }
}
Previous TopicAny Message
Next TopicMessage Revoked

Command Palette

Search for a command to run...