Message status updated

Notifies your endpoint whenever the status of an outgoing message changes.

Trigger

This webhook is triggered whenever an outgoing message's status changes. It applies exclusively to WhatsApp Business API and QR API channels. Incoming messages do not generate status updates.

Status values

enqueuedMessage reached the API client successfully.
sentMessage delivered to the recipient's device.
deliveredMessage confirmed on the end-user device.
readThe end user has read the message.
failedDelivery was unsuccessful (a failure reason is provided).
mismatchWhatsApp auto-corrected the phone number.
deletedMessage removed by the recipient (deprecated; no longer supported by Meta).

Example payload

json

{
  "event": "message_status_updated",
  "payload": {
    "uuid": "adf3d1216d4c4dcd908199d6700f2381",
    "status": "read",
    "contact": {
      "href": "https://dash.try-eclectic.com/contacts/eb2b914a977e4ab896e7b886698b3eac",
      "conversationHref": "https://dash.try-eclectic.com/chat/f3670b13446b412796238b1cd78899f9",
      "name": "John Doe",
      "tags": ["Lead"],
      "uuid": "eb2b914a977e4ab896e7b886698b3eac",
      "source": "whatsapp",
      "avatarUrl": null,
      "createdAt": "2022-10-12T15:57:16Z",
      "phoneNumber": "331122334455"
    },
    "messageStatusPayload": {
      "id": "gBGGM2MSRxl_Aglqmg5KQXU7ABC",
      "gsId": "2b34bfb7-2631-4763-89fb-1b3c65a4babc",
      "type": "read",
      "payload": {
        "ts": 1686563913
      },
      "destination": "1122334455"
    }
  }
}