Skip to main content

Delivery Status Webhook

For the messages triggered by chakra APIs (not the pass through API), you can listen to the message status through a delivery status webhook.

Please note

  • The events might be out of order
  • There is no retry mechanism for missed events

The webhook can be cofigured under the webhook setting of the whatsapp plugin page (as in the screenshot below)

Webhook config

Event format

When successfully subsribed, You will receive an even in the following format

{
"event": "deliveryStatus",
"payload": {
"id": "39718a7c-b747-446c-a2ee-ce977e608b49",
"externalId": "wamid.HBgMOTE5OTAxMjU4NDMzFQIAERgSNjNBMkZBQzdBMEUzMEQxNzAzAA==",
"deliveryStatus": "SENT",
"timestamp": 1729230548000,
"recipientId": "919448349676"
}
}

Params

ParamDescription
eventThe value for event param will be deliveryStatus for all delivery status events
payloadThis will contain the actual deliver ystatus object

Payload params

ParamDescription
idThis is the chat message id for which we have received a delivery status event
externalIdThis is the whatsapp message id for which we have received a delivery status event
deliveryStatusthis can be either one of SENT, DELIVERED, READ
timestampa unix epoch timestamp in millis denoting the time when which this event was generated
recipientIdthe customer phone number for which this staus event was generated