Navigate to Integrations -> Outbound Webhooks
WhatsApp Delivery Receipts
- Select the service you are sending the WhatsApp messages from
- Select the channel as WhatsApp
{
"deliveryInfoNotification": {
"subtid": "",
"deliveryInfo": {
"deliveryChannel": "whatsapp",
"Description": "Submitted",
"destinationType": "waid",
"timeStamp": "2019-03-04T09:49:20.429Z",
"code": "7501",
"additionalInfo": "",
"deliveryStatus": "Submitted",
"destination": "9199xxxxxxxx",
"identityKeyHash": "z2XXXXXXbBA="
},
"correlationid": "",
"callbackData": "",
"transid": "5c9f6594-a371-4e78-8561-b695f9647472"
}
}
{
"deliveryInfoNotification": {
"subtid": "",
"deliveryInfo": {
"deliveryChannel": "whatsapp",
"Description": "Delivered",
"destinationType": "waid",
"timeStamp": "2019-03-04T09:49:21.157Z",
"code": "7500",
"additionalInfo": "",
"deliveryStatus": "Delivered",
"destination": "9199xxxxxxxx",
"identityKeyHash": "z2XXXXXXbBA="
},
"correlationid": "",
"callbackData": "",
"transid": "5c9f6594-a371-4e78-8561-b695f9647472"
}
}
{
"deliveryInfoNotification": {
"subtid": "",
"deliveryInfo": {
"deliveryChannel": "whatsapp",
"Description": "Read",
"destinationType": "waid",
"timeStamp": "2019-03-04T09:49:24.849Z",
"code": "7502",
"additionalInfo": "",
"deliveryStatus": "Read",
"destination": "9199xxxxxxxx",
"identityKeyHash": "z2XXXXXXbBA="
},
"correlationid": "",
"callbackData": "",
"transid": "5c9f6594-a371-4e78-8561-b695f9647472"
}
}
{
"deliveryInfoNotification":
{
"deliveryInfo":
{
"timeStamp": "2020-04-24T08:27:13.289Z",
"Description": "Inavlid whatsapp destination",
"code": "7737",
"deliveryChannel": "whatsapp",
"additionalInfo": "Invalid waid",
"destination": "XXXXXXXXXXX",
"destinationType": "waid",
"deliveryStatus": "Failed"
},
"subtid": "",
"transid": "40d93325-4651-4c67-9de1-fe9aff7dda3f",
"callbackData": "",
"correlationid": "1ea5cd99-6cac-4c6e-a351-ffa42244842f"
}
}
WhatsApp Incoming Messages & Events
Select the app that you expect to receive messages or events from as the Entity.
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_155054536910425280",
"event": "MO",
"waid": "9199xxxxxxxx",
"message": "Hello",
"attachments": "[]",
"system": "",
"location": "",
"ts": "2019-03-03T07:40:51.297Z",
"tid": "0cab6280-9d98-0041-4877-0bde6515b15a_0",
"identityKeyHash": "z2XXXXXXbBA="
}
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_154623235593581600",
"event": "MO",
"waid": "9187xxxxxxxx",
"message": "",
"attachments": "[{\"mime_type\":\"image/jpeg\",\"url\":\"https://stgrtmedia.s3.amazonaws.com/a_154623235593581600/d3aa15e8-93ee-4e79-bb31-0ad3f0fe7430.jpg\"}]",
"system": "",
"location": "",
"ts": "2019-01-03T09:04:42.726Z",
"tid": "5b11ed3b-36fb-9336-bb58-11429b0b78aa_0"
}
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_154623235593581600",
"event": "MO",
"waid": "9187xxxxxxxx",
"message": "",
"attachments": "[{\"mime_type\":\"video/mp4\",\"url\":\"https://stgrtmedia.s3.amazonaws.com/a_154623235593581600/aa9b851f-94b6-49f6-878c-ea8a8d7b3098.mp4\"}]",
"system": "",
"location": "",
"ts": "2019-01-03T09:23:26.386Z",
"tid": "ff0f3e02-e812-22f7-dc15-dba71dabde53_0"
}
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_154529859479452060",
"event": "MO",
"waid": "9187xxxxxxxx",
"message": "",
"attachments": "[]",
"system": "",
"location": "{\"address\":\"Plot No. 770, Road No. 44, Jubilee Hills, Hyderabad\",\"latitude\":\"17.434901060022\",\"name\":\"Imimobile\",\"url\":\"https://www.facebook.com/pages/Imimobile/204627936239899\",\"longitude\":\"78.398435572505\"}",
"ts": "2019-01-08T08:59:02.717Z",
"tid": "3beecbfb-73fd-803e-a27f-4e797fb22ffd_0",
"identityKeyHash": "z2XXXXXXbBA="
}
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_154623235593581600",
"event": "MO",
"waid": "9187xxxxxxxx",
"message": "",
"attachments": "[{\"mime_type\":\"audio/mpeg\",\"url\":\"https://stgrtmedia.s3.amazonaws.com/a_154623235593581600/ef484891-d99c-45b9-af97-c5ad0e7abef6\"}]",
"system": "",
"location": "",
"ts": "2019-01-03T08:03:04.866Z",
"tid": "88be8081-8579-2a56-3e03-cee8b01afdb2_0"
}
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_154623235593581600",
"event": "MO",
"waid": "9187xxxxxxxx",
"message": "",
"attachments": "[{\"mime_type\":\"application/msword\",\"caption\":\"This is PPT-1\",\"url\":\"https://stgrtmedia.s3.amazonaws.com/a_154623235593581600/21bb5a4a-fd0e-47d3-a02d-b1af0eddbe88.ppt\"}]",
"system": "",
"location": "",
"ts": "2019-01-03T08:59:16.192Z",
"tid": "5a7898e0-d80b-7316-dd80-7849f84fa304_0"
}
{
"userId": "",
"channel": "WhatsApp",
"appId": "a_159668984571987230",
"event": "MO",
"waid": "91809XXXXXXX",
"message": "",
"attachments": "[]",
"system": "",
"location": "",
"ts": "2023-05-17T06:48:11.203-04:00",
"tid": "6481de56-44c7-0479-120d-f3e26ea3b9c5_0",
"contacts": "[{\"emails\":[],\"addresses\":[],\"urls\":[],\"org\":{},\"name\":{\"last_name\":\"last_name\",\"first_name\":\"first_name\",\"formatted_name\":\"Self Jio\"},\"phones\":[{\"phone\":\"+91 78xxxxxxxx\",\"wa_id\":\"9178xxxxxxxx\",\"type\":\"Mobile\"}]}]",
"username": "Username",
"identityKeyHash": "z2XXXXXXbBA="
}
{
"userId": "",
"channel": "WhatsApp",
"appId": "a_159668984571987230",
"event": "MO",
"waid": "91809XXXXXXX",
"message": "",
"attachments": "[{\"sticker\":{\"metadata\":{\"emojis\":[null],\"sticker_pack_id\":\"\",\"sticker_pack_name\":\"\",\"android_app_store_link\":\"\",\"ios_app_store_link\":\"\",\"is_first_party_sticker\":\"\",\"sticker_pack_publisher\":\"\"},\"sha256\":\"80c2cee74b49bfd30c2552d30cbd8b5295b4c20958643a94715362e52d8bf0d4\",\"mime_type\":\"image/webp\",\"id\":\"42ca7cdb-7a23-481a-a4c0-51a0f0cd1b8c\"},\"url\":\"https://imi-wamedia-us.s3.amazonaws.com/a_159668984571987230/42ca7cdb-7a23-481a-a4c0-51a0f0cd1b8c.webp\"}]",
"system": "",
"location": "",
"ts": "2023-05-17T06:52:50.641-04:00",
"tid": "5c981edd-5446-11cd-f722-7646454606bd_0",
"contacts": "[]",
"username": "Username"
}
{
"userId": "",
"username": "",
"channel": "WhatsApp",
"appId": "a_160981352754574140",
"event": "postback",
"waid": "9199xxxxxxxx",
"ts": "2021-02-05T11:49:57.374Z",
"tid": "b1fbebed-d6a5-f9fe-11b7-bf82b1a18fea_0",
"buttonPayload": "aGlzIHRoaXMgaXMgY29vZHNhc2phZHdpcXdlMGZoIGFTIEZISUQgV1FEV0RT",
"buttonText": "Yes",
"errors": "",
"identityKeyHash": "z2XXXXXXbBA="
}
{
"userId": "",
"channel": "WhatsApp",
"appId": "a_159668984571987230",
"event": "list",
"waid": "91809XXXXXXX",
"listRowIdentifier": "unique-row-identifier-1",
"listRowTitle": "Row-title-1",
"listRowDescription": "Row-description",
"contextId": "gBEGkYCWEgQIAgm7ulCWGFk3SCE",
"ts": "2023-05-17T06:43:12.051-04:00",
"tid": "1b702833-a885-4220-408f-ccfb61da74fa_0",
"username": "ABCD",
"identityKeyHash": "z2XXXXXXbBA="
}
{
"userId": "",
"channel": "WhatsApp",
"appId": "a_159668984571987230",
"event": "reply",
"waid": "91809XXXXXXX",
"replyButtonIdentifier": "ButtonId1",
"replyButtonTitle": "First Button",
"contextId": "gBEGkYCWEgQIAgnurPKN2uP0DOw",
"ts": "2023-05-17T06:46:42.568-04:00",
"tid": "7168c0d1-2b41-8a0e-c952-202afe053842_0",
"username": "ABCD",
"identityKeyHash": "z2XXXXXXbBA="
}
Note
The usage of the
identityKeyHashoutput variable is limited to Cloud API-based WhatsApp business numbers. This capability is not available for existing on-premises numbers. To utilize this feature, you must migrate your numbers to the Cloud API.