Skip to main content

🔗 Webhooks

Configure your system to receive real-time updates from WhatsApp.

Inbound Message Event​

Fired whenever a customer sends a message to your WhatsApp number.

Payload Sample​

{
"event": "message",
"session": "my-session",
"payload": {
"id": "[email protected]_3EB0...",
"from": "[email protected]",
"body": "Help with order",
"timestamp": 1713345600
},
"metadata": {
"agencyId": "64a1b...",
"tenantId": "64a1b..."
}
}

Event Types​

EventDescription
messageStandard incoming message.
message.ackDelivery status update (sent, delivered, read).
message.revokedFired when a message is deleted by the user.
session.statusSession lifecycle updates (WORKING, FAILED, etc.).
presence.updateContact typing or online status updates.

Message Ack (Delivery Status)​

Fired when a message is sent, delivered, or read.

Status Values​

  • 1: Sent (left the engine).
  • 2: Delivered (received by customer).
  • 3 or 4: Read (opened by customer).
  • -1: Failed.