Here’s a list of events that can be used to send payload to the provided webhook URL.
| Product | Event | Description |
|---|---|---|
| SMS | sms:message:status | Acknowledgment of message delivery or undelivery. |
| SMS | sms:unsubscription | Acknowledgment of opting out from any number. |
| whatsapp:message:in | For receiving updates when user send message to Whatsapp number | |
| whatsapp:message:status | For receiving DLR Status from Whatsapp number to user | |
| whatsapp:unsubscription | Acknowledgment of opting out from any number. | |
| RCS | rcs:message:in | For receiving Rcs message event |
| RCS | rcs:message:status | For receiving Rcs delivery updates |
| RCS | rcs:unsubscription | Acknowledgment of opting out from any number. |
| Voice | voice:message:out | To receive acknowledgments after CDR events. |
| Voice | voice:unsubscription | Acknowledgment of opting out from any number. |
| Interact | vmn:message:in | Once we receive the acknowledgment, we will send the same to the webhook. |
| Contact | contacts:subscriber:subscription | For receiving Contacts creation and updation Event payload. |
When you Subscribe to any of these Events, it will forward the payload of a sent or received message/call to the client’s specified Webhook URL.
{
"id": "b34e35ad-fe34-4a8b-977c-b21cd76cd7d6:1",
"mobile": "918921269xxx",
"status": "DELIVRD",
"credits": "2.0000",
"units": 2,
"deliv_time": "2021-04-09 16:27:51",
"sent_time": "2021-04-09 16:27:35",
"submit_time": "2021-04-09 16:27:39",
"cid": "1234444XXXX",
"custom": "9882XXXX",
}
{
"id": "d105a1ef-6728-4563-8b85-7f5356c8axxx",
"receiver": "917002088xxx",
"type": "sender",
"value": "Demo12",
"created_at": "2023-07-08T12:52:54.000000Z",
"status": "Unsubscriber created successfully"
}
For more details on SMS webhook : [Read Here]
{
"event": "whatsapp:message:status",
"payload": {
"id": "a418d672-9781-4d97-b517-a56f7d95ad8a",
"channel": "whatsapp",
"from": "919019120xxx",
"to": "9190199xxxxx",
"status": "sent|delivered|read|failed|deleted",
"delivered_at": "2021-06-18T14:48:06.886358Z",
"read_at": "2021-06-18T14:48:06.886358Z",
"processed_at": "2021-06-18T14:48:06.886358Z",
"timestamp": "2021-06-18T14:48:06.886358Z",
"foreign_id": "your-business-identifier"
}
}
{
"event": "whatsapp:message:in",
"payload": {
"id": "our-message-id",
"channels": [
{
"name": "whatsapp",
"to": "919019120xxx"
}
],
"recipient": {
"from": "91XXXXXX",
"user": {
"id": "unique-user-id",
"username": "username",
"first_name": "user first name",
"last_name": "user last name",
"email": null,
"phone": "user phone number",
"user_info": {
"picture": "url-of-profile-picture",
"gender": null,
"title": "user status or designation"
}
}
},
"message": {
"type": "text",
"payload": {
"text": "This is a simple text message from whatsapp channel"
}
}
}
}
{
"event": "whatsapp:message:in",
"payload": {
"id": "our-message-id",
"channels": [
{
"name": "whatsapp",
"to": "919019120xxx"
}
],
"recipient": {
"from": "91XXXXXX",
"user": {
"id": "unique-user-id",
"username": "username",
"first_name": "user first name",
"last_name": "user last name",
"email": null,
"phone": "user phone number",
"user_info": {
"picture": "url-of-profile-picture",
"gender": null,
"title": "user status or designation"
}
}
},
"message": {
"type": "image",
"payload": {
"url": "https://domin-name.com/your_image_path.png",
"caption": "some caption for image",
"filename": ""
}
}
}
}
{
"id": 436,
"receiver": "91700208xxxx",
"type": "category",
"value": "WUC",
"created_at": "2023-07-08T12:27:39.000000Z",
"status": "Unsubscriber created successfully"
}
For more details on Whatsapp webhook : [Read Here]
{
"event": "rcs:message:status",
"payload": {
"id": "a418d672-9781-4d97-b517-a56f7d95ad8a",
"channel": "rcs",
"from": "700969ca-0cb2-11ec-a2cxxxx",
"to": "9190199xxxxx",
"status": "sent|delivered|read|failed|deleted",
"delivered_at": "2021-06-18T14:48:06.886358Z",
"read_at": "2021-06-18T14:48:06.886358Z",
"processed_at": "2021-06-18T14:48:06.886358Z",
"timestamp": "2021-06-18T14:48:06.886358Z",
"foreign_id": "your-business-identifier"
}
}
{
"event": "rcs:message:in",
"payload": {
"id": "our-message-id",
"channels": [
{
"name": "rcs",
"to": "919019120xxx"
}
],
"recipient": {
"from": "91XXXXXX",
"user": {
"id": "unique-user-id",
"username": "username",
"first_name": "user first name",
"last_name": "user last name",
"email": null,
"phone": "user phone number",
"user_info": {
"picture": "url-of-profile-picture",
"gender": null,
"title": "user status or designation"
}
}
},
"message": {
"type": "text",
"payload": {
"text": "This is a simple text message from whatsapp channel"
}
}
}
}
{
"event": "rcs:message:in",
"payload": {
"id": "our-message-id",
"channels": [
{
"name": "rcs",
"to": "919019120xxx"
}
],
"recipient": {
"from": "91XXXXXX",
"user": {
"id": "unique-user-id",
"username": "username",
"first_name": "user first name",
"last_name": "user last name",
"email": null,
"phone": "user phone number",
"user_info": {
"picture": "url-of-profile-picture",
"gender": null,
"title": "user status or designation"
}
}
},
"message": {
"type": "image",
"payload": {
"url": "https://domin-name.com/your_image_path.png",
"caption": "some caption for image",
"filename": ""
}
}
}
}
{
"id": 73,
"receiver": "917002088xxx",
"type": "all",
"value": "*",
"created_at": "2023-07-08T12:31:47.000000Z",
"status": "Unsubscriber created successfully"
}
For more details on RCS webhook : [Read Here]
{
"bridge": 91806828XXXX,
"from": 91891952XXXX,
"to": 91886713XXXX,
"source": "OBD",
"mid": "1234-1333-XXXXX",
"flow_id": 123,
"start_at": "2021-04-09 16:27:39",
"end_at": "2021-04-09 16:27:55",
"duration": "23",
"status": "ANSWER",
"recording_url": "https://youraudiofilelocation/",
}
{
"id": "69ff18e3-4a34-4994-bb67-32c393f8exxx",
"receiver": "917002088xxx",
"type": "all",
"value": "*",
"created_at": "2023-07-08T12:59:01.000000Z",
"status": "Unsubscriber created successfully"
}
For more details on Reach webhook : [Read Here]
{
"id": 86,
"identity": "demo@gmail.com",
"first_name": "Demo",
"middle_name": null,
"last_name": "Test",
"gender": "male",
"birth_date": "1996-07-16",
"company": null,
"attributes": {
"membership": "platinum",
"status": "vip",
"customerNumber": "23"
},
"created_at": "2023-07-16T11:45:34.000000Z",
"updated_at": "2023-07-16T11:45:34.000000Z",
"status": "Subscriber created successfully"
}
{
"id": 86,
"identity": "demo@gmail.com",
"first_name": "Demo",
"middle_name": null,
"last_name": "Test",
"gender": "male",
"birth_date": "1996-07-16",
"company": null,
"attributes": {
"membership": "platinum",
"status": "vip",
"customerNumber": "23"
},
"created_at": "2023-07-17T11:45:34.000000Z",
"updated_at": "2023-07-17T11:46:06.000000Z",
"status": "Subscriber updated successfully"
}