Get webhook notifications on inbound messages and status updates of outbound messages
Webhooks are there to inform you in near real-time about inbound messages and replies. Also, you can get status updates on sent messages wherever the platforms support it.
Use the /webhooks API endpoint to subscribe to webhooks, get, update, or delete active webhook subscriptions.
The webhook payload object is sent whenever an event triggers that you have subscribed to. Inbound and outbound message webhooks re-use the same object. We have not added other events yet, but platform events will likely use a slightly different object structure due to their different nature.
Example of a webhook payload
{
"id": "pe_23323q445ecf334qwe213",
"event": "MESSAGE_INBOUND",
"message":
{
"id": "ms_23323q445ecf334qwe213",
"url": "/messages/ms_23323q445ecf334qwe213",
"created_at": "2023-02-28T10:01:12.928Z",
"updated_at": "2023-02-28T10:01:12.928Z",
"status": "RECEIVED",
"direction": "INBOUND",
"to": [
{
"channel_id": "mc_023u40oqnscone0fu30cese32dweh"
}
],
"from": {
"contact_id": "co_12394ru02wdoncn3d034",
"identifier": "[email protected]"
},
"content": {
"body": "Hello world!",
"type": "text"
},
"conversation_id": "cv_023u40oqnscone0fu30cese32dweh"
}
}