Event triggered when a message's status is updated (e.g., delivered, read).
Webhook Event: messages.update
Triggered when a message's status is updated (e.g., delivered, read). The payload contains the updated status and message key.
See the code example below for the typical payload structure.
Status Codes
| Status Code | Description | Explanation |
|---|---|---|
| 0 | ERROR | The message failed to send due to an error. |
| 1 | PENDING | The message is queued and waiting to be sent. |
| 2 | SENT | The message has been sent from the server but not yet delivered. |
| 3 | DELIVERED | The message has reached the recipient’s device. |
| 4 | READ | The recipient has opened and read the message. |
| 5 | PLAYED | The recipient has played the media message (e.g., audio or video). |
Code Examples
{
"event": "messages.update",
"sessionId": "your_api_key",
"data": {
"update": {
"status": 2
},
"key": {
"remoteJid": "[email protected]",
"id": "34874643876",
"fromMe": false
}
},
"timestamp": 1747775431467
}