Webhook payload
1. Webhook Broadcast
Response
{
"messageId": "7f3b46e9-704c-4125-b7e7-ff31a90c2b79",
"cause": "READ",
"clientMessageId": "5833f6f3-4c2d-4cb2-82b3-848e9313ff10",
"timestamp": 174911328000,
"type": 1,
"status": 5,
"publicId": "4b7e9a95-e6e5-43c7-9c0c-f7d0ed37262b",
"applicationId": 1
}| Name | Type | Description |
|---|---|---|
| messageId | String | messageId is the id of the message used to check the status message history |
| cause | String | cause is the status of the message message 1. READ 2. DELIVERED 3. FAIL 4. SEND |
| clientMessageId | String | A unique ID requested by the client and generated by our system to identify the message-sending request |
| timestamp | Number | timestamp is the time the system status is received |
| type | Number | 1. Broadcast 2. Conversation |
| status | Number | Follow section III 1. PENDING 2. SENT 3. FAIL 4. DELIVERED 5. READ |
| publicId | String | publicId is the id of the message used to check the status. |
| applicationId | Number | - 1: viber - 10: viber bot - 3: sms |
2. Webhook Conversation
Response
{
"from": "3d2ed575-f552-4b5d-8888-c33cb62f9f9c",
"contact": {
"avatarUrl": "",
"name": "Hà Phước Hòa",
"language": "en",
"country": "VN",
"address": null,
"phone": ""
},
"messageId": "f543ae0c-e802-413c-862d-f1dad79ec562",
"message": {
"type": "text",
"message": "hoha",
"extra": {
"text": "hoha",
"type": "text"
}
},
"timestamp": 1749539924549,
"type": 2,
"channelId": "917df4d0-7eb7-11ee-b9de-1727a5a284e5",
"publicId": "917df4d0-7eb7-11ee-b9de-1727a5a284e5",
"applicationId": 10
}Response Fields
| Name | Type | Description |
|---|---|---|
| from | String | public conversation |
| contact | Object | Contact person information |
| messageId | String | MessageId is the id of the message used to check the status or message history |
| message | Object | Detailed information about message content |
| timestamp | Number | timestamp is the time the system status is received |
| type | Number | 1. EVENT 2. MESSAGE 3. TEMPLATE 4. CHANNEL |
| channelId | String | ID of the channel through which the message was sent |
| publicId | String | publicId is the id of the message used to check the status |
| applicationId | Number | 1: viber 10: viber bot |
Modified at 2026-04-20 10:16:13