> ## Documentation Index
> Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.
# On receive callback examples
> Received message webhook callback examples by message type
## Webhook callback
### Common attributes
All webhook callbacks share the following common attributes:
Identifies if the received message is a status reply
WhatsApp contact identifier
Phone number connected to the API
Identifies if your message is in the "Waiting for message" status
Identifies if the received message was edited
Indicates if the chat is a group
Indicates if the chat is a channel
Unique identifier for the instance that received the message
Message identifier in the conversation
Phone number or group that sent the message
Indicates if the message was sent from the number connected to the API
Moment when the message was received or the error occurred
Status of the message at the time of sending the callback (PENDING, SENT, RECEIVED, READ, or PLAYED)
Name of the chat or participant that originated the message
URL of the sender's photo
Sender's display name
Phone number of the group member who sent the message
WhatsApp contact ID of the group participant who sent the message
Indicates if the message was sent to a broadcast list
Type of instance event, in this case `ReceivedCallback`
Type of event when receiving a call, indicating whether it is a video call or not
***
## Callback examples by type
### Text and media messages
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"text": {
"message": "test",
"description": "(optional) in case the message has a description inserted by WhatsApp",
"title": "(optional) in case the message has a title inserted by WhatsApp",
"url": "(optional) in case the message has a linked URL",
"thumbnailUrl": "(optional) in case the message has a thumbnail image"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228828000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"image": {
"mimeType": "image/jpeg",
"imageUrl": "https://",
"thumbnailUrl": "https://",
"downloadError": null,
"caption": "",
"width": 600,
"height": 315,
"viewOnce": true
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228849000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"audio": {
"ptt": true,
"seconds": 10,
"audioUrl": "https://",
"mimeType": "audio/ogg; codecs=opus",
"viewOnce": true
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228889000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"video": {
"videoUrl": "https://",
"caption": "",
"mimeType": "video/mp4",
"seconds": 13,
"viewOnce": true
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": true,
"momment": 1688496074000,
"status": "RECEIVED",
"chatName": "eu",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantPhone": "5544999999999",
"messageExpirationSeconds": 0,
"forwarded": true,
"type": "ReceivedCallback",
"video": {
"videoUrl": "https://",
"caption": "",
"mimeType": "video/mp4"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228889000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"video": {
"videoUrl": "https://",
"caption": "",
"mimeType": "video/mp4"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228955000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"document": {
"documentUrl": "https://",
"mimeType": "application/pdf",
"title": "name",
"pageCount": 1,
"fileName": "name.pdf"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"contact": {
"displayName": "Cesar Baleco",
"vCard": "BEGIN:VCARD\\nVERSION:3.0\\nN:;name;;;\\nFN:name\\nTEL;type=CELL;type=VOICE;waid=5544999999999:+55 44 9999-9999\\nEND:VCARD",
"phones": ["5544999999999"]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228970000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"location": {
"longitude": -99.999999999999999,
"latitude": -99.9999999999999999,
"address": "",
"url": ""
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228982000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"sticker": {
"stickerUrl": "https://",
"mimeType": "image/webp"
}
}
```
### Reactions and interactions
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228955000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"reaction": {
"value": "❤️",
"time": 1651878681150,
"reactionBy": "554499999999",
"referencedMessage": {
"messageId": "3EB0796DC6B777C0C7CD",
"fromMe": true,
"phone": "5544999999999",
"participant": null
}
}
}
```
### Polls
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"poll": {
"question": "Qual a melhor API de WhatsApp?",
"pollMaxOptions": 0,
"options": [
{
"name": "Z-API"
},
{
"name": "Outras"
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": "if group, this will be the participant who responded",
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"pollVote": {
"pollMessageId": "ID of the poll message that was answered",
"options": [
{
"name": "Z-API"
}
]
}
}
```
### Buttons and lists
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1634645380000,
"status": "RECEIVED",
"chatName": "Nome",
"senderPhoto": "https://",
"senderName": "Nome",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"referenceMessageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"forwarded": false,
"type": "ReceivedCallback",
"buttonsResponseMessage": {
"buttonId": "1",
"message": "Great"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1634645683000,
"status": "RECEIVED",
"chatName": "Nome",
"senderPhoto": "https://",
"senderName": "Nome",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"referenceMessageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"forwarded": false,
"type": "ReceivedCallback",
"listResponseMessage": {
"message": "Z-API Wings for your imagination",
"title": "Z-API",
"selectedRowId": "1"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "9D968A5FA2880508C4",
"phone": "554499999999",
"fromMe": false,
"momment": 1708455444850,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"buttonsMessage": {
"imageUrl": "Image URL",
"videoUrl": null,
"message": "Message text",
"buttons": [
{
"buttonId": "1",
"type": 1,
"buttonText": {
"displayText": "Button 1 text"
}
},
{
"buttonId": "2",
"type": 1,
"buttonText": {
"displayText": "Button 2 text"
}
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "9D968A5FA2880508C4",
"phone": "554499999999",
"fromMe": false,
"momment": 1708455444850,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"buttonsMessage": {
"imageUrl": null,
"videoUrl": "Video URL",
"message": "Message text",
"buttons": [
{
"buttonId": "1",
"type": 1,
"buttonText": {
"displayText": "Button 1 text"
}
},
{
"buttonId": "2",
"type": 1,
"buttonText": {
"displayText": "Button 2 text"
}
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "9D968A5FA2880508C4",
"phone": "554499999999",
"fromMe": false,
"momment": 1708455444850,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {},
"message": "message text",
"footer": "",
"title": "",
"templateId": "",
"hydratedButtons": [
{
"urlButton": {
"displayText": "Copy code",
"url": "https://www.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp123"
},
"index": 0
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "9D968A5FA2880508C4",
"phone": "554499999999",
"fromMe": false,
"momment": 1708455444850,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"pixKeyMessage": {
"currency": "BRL",
"referenceId": "4PXRAHSIRDA",
"key": "pixkey",
"keyType": "EVP",
"merchantName": "Pix"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": null,
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "554499999999",
"fromMe": true,
"momment": 1739368022130,
"status": "SENT",
"chatName": "Nome",
"senderPhoto": null,
"senderName": "Nome",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": true,
"carouselMessage": {
"text": "Message text",
"cards": [
{
"header": {
"image": {
"imageUrl": "https://",
"thumbnailUrl": "https://",
"caption": "",
"mimeType": "image/jpeg",
"viewOnce": false,
"width": 0,
"height": 0
}
},
"message": "Carousel card message",
"footer": "",
"title": "",
"hydratedButtons": [
{
"index": 0,
"urlButton": {
"displayText": "Button text",
"url": "https://"
}
},
{
"index": 1,
"quickReplyButton": {
"displayText": "Button text",
"id": "2"
}
}
]
},
{
"header": {
"image": {
"imageUrl": "https://",
"thumbnailUrl": "https://",
"caption": "",
"mimeType": "image/jpeg",
"viewOnce": false,
"width": 0,
"height": 0
}
},
"message": "Carousel card message",
"footer": "",
"title": "",
"hydratedButtons": [
{
"index": 0,
"urlButton": {
"displayText": "Button text",
"url": "https://"
}
},
{
"index": 1,
"quickReplyButton": {
"displayText": "Button text",
"id": "2"
}
}
]
}
]
}
}
```
### Templates
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "702CC5F7E0A6BF4421",
"phone": "5544999999999",
"fromMe": false,
"momment": 1708457193876,
"status": "RECEIVED",
"chatName": "Test Number",
"senderPhoto": null,
"senderName": "5544999999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {},
"message": "message text",
"footer": "message footer",
"title": "message title",
"templateId": "790118069824606",
"hydratedButtons": []
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "885FF934BF100D579E",
"phone": "554499999999",
"fromMe": false,
"momment": 1708454725028,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"image": {
"imageUrl": "https://example.jpeg",
"thumbnailUrl": "https://example.jpeg",
"caption": "",
"mimeType": "image/jpeg",
"viewOnce": false,
"width": 1600,
"height": 926
}
},
"message": "message text",
"footer": "message footer",
"title": "message title",
"templateId": "674504507982622",
"hydratedButtons": []
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "0E4AD761B62E3D5EF9",
"phone": "5544999999999",
"fromMe": false,
"momment": 1708456287181,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "5544999999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"video": {
"videoUrl": "https://example.mp4",
"caption": "",
"mimeType": "video/mp4",
"width": 0,
"height": 0,
"seconds": 0,
"viewOnce": false
}
},
"message": "message text",
"footer": "message footer",
"title": "message title",
"templateId": "938481574354947",
"hydratedButtons": []
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "9D968A5FA2880508C4",
"phone": "554499999999",
"fromMe": false,
"momment": 1708455444850,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"document": {
"documentUrl": "https://example.pdf",
"mimeType": "application/pdf"
}
},
"message": "message text",
"footer": "message footer",
"title": "message title",
"templateId": "811492407484976",
"hydratedButtons": []
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "27BBF23E0185D363D9",
"phone": "554499999999",
"fromMe": false,
"momment": 1708456969808,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "554499999999",
"photo": null,
"broadcast": false,
"participantLid": null,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"hydratedTemplate": {
"header": {
"location": {
"longitude": -46.6388,
"latitude": -23.5489,
"name": "place name",
"address": "address name"
}
},
"message": "message text",
"footer": "message footer",
"title": "message title",
"templateId": "1143940003434066",
"hydratedButtons": []
}
}
```
### Ads
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isGroup": false,
"isEdit": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1657209752000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": null,
"broadcast": false,
"externalAdReply": {
"title": "Title",
"body": "ad text",
"mediaType": 1,
"thumbnailUrl": "https://",
"sourceType": "ad",
"sourceId": "23722824350495506",
"ctwaClid": "Aff-niaAw7V94N8LGd79Vjr43TlJD4UnoBdpZJQ3LzABitbbG6wgKBSVOth4EN0IDr9glsKWjm2LBaFrJG3Nb0ILxP49ZtossVBNzlS8cFXBvv2ow7gNw",
"sourceUrl": "https://",
"containsAutoReply": false,
"renderLargerThumbnail": true,
"showAdAttribution": true
},
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"text": {
"message": "received message",
"description": "ad text",
"title": "title",
"url": "https://",
"thumbnailUrl": "https://"
}
}
```
### Products and orders
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632233527000,
"status": "RECEIVED",
"senderPhoto": "https://",
"senderName": "5544999999999",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"product": {
"productImage": "https://",
"businessOwnerJid": "5544999999999",
"currencyCode": "BRL",
"productId": "99999999999999999999",
"description": "",
"productImageCount": 1,
"price": 1,
"url": "",
"retailerId": "",
"firstImageId": "",
"title": "name"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632233527000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"forwarded": false,
"type": "ReceivedCallback",
"order": {
"itemCount": 1,
"orderId": "422508169684569",
"message": "",
"orderTitle": "name",
"sellerJid": "5544999999999",
"thumbnailUrl": "https://",
"token": "AR5d4yUr+DmSzeCR2kUtPEeMfS+eG0O+S/T/17B+oY1mfA==",
"currency": "BRL",
"total": 2000,
"subTotal": 2000,
"products": [
{
"quantity": 1,
"name": "nameProduct",
"productId": "5338924696127051",
"retailerId": "1242",
"price": 2000,
"currencyCode": "BRL"
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"reviewOrder": {
"currency": "BRL",
"referenceId": "4N9AVI38VOB",
"orderRequestId": "4N9AVI38VYZ",
"orderStatus": "processing",
"paymentStatus": "pending",
"total": 605,
"subTotal": 600,
"discount": 10,
"shipping": 5,
"tax": 10,
"products": [
{
"name": "order 1",
"quantity": 2,
"isCustomItem": true,
"productId": "custom-item-4N9AVI38WI1",
"value": 150
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"reviewAndPay": {
"type": "physical-goods",
"currency": "BRL",
"referenceId": "4N9AVI38VOB",
"orderRequestId": "4N9AVI38VYZ",
"orderStatus": "pending",
"paymentStatus": "pending",
"total": 605,
"subTotal": 600,
"discount": 10,
"shipping": 5,
"tax": 10,
"products": [
{
"name": "order 1",
"quantity": 2,
"isCustomItem": true,
"productId": "custom-item-4N9AVI38WI1",
"value": 150
}
]
}
}
```
### Payments
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632229683000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"requestPayment": {
"value": 1,
"currencyCode": "BRL",
"expiration": 1632834482000,
"requestPhone": "5544999999999",
"paymentInfo": {
"receiverPhone": "5544999999999",
"value": 1,
"currencyCode": "BRL",
"status": "WAITING",
"transactionStatus": "COLLECT_SUCCESS"
}
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632230512000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"sendPayment": {
"paymentInfo": {
"receiverPhone": "5544999999999",
"value": 1,
"currencyCode": "BRL",
"status": "COMPLETE",
"transactionStatus": "SUCCESS"
}
}
}
```
### Events
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "120363019502650977-group",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"event": {
"name": "Event name",
"description": "Event description",
"canceled": false,
"joinLink": "https://call.whatsapp.com/video/v9123XNFG50L6iO79NddXNvKQr6bb3",
"scheduleTime": 1716915653,
"location": {}
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "120363019502650977-group",
"fromMe": false,
"momment": 1632228638000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"eventResponse": {
"response": "GOING",
"responseFrom": "554499999999",
"time": 1714423417000,
"referencedMessage": {
"messageId": "D2D612289D9E8F62307D72409A8D9DC3",
"fromMe": false,
"phone": "120363239161320697-group",
"participant": "554499999988"
}
}
}
```
### Other interactions
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": true,
"momment": 1632228955000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"pinMessage": {
"action": "pin",
"pinDurationInSecs": 604800,
"referencedMessage": {
"messageId": "3EB0796DC6B777C0C7CD",
"fromMe": true,
"phone": "554499999999",
"participant": null
}
}
}
```
### Status and profile
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
},
"statusImage": {
"imageUrl": "https://",
"thumbnailUrl": "https://",
"caption": "teste",
"mimeType": "image/jpeg",
"width": 960,
"height": 1280
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
},
"statusVideo": {
"videoUrl": "https://f004.backblazeb2.com/file/temp-file-download/instances/3FXXXXXXXXXXXXXXXXXXXXXXXF/3XXXXXXXXXXXXXXXX64/9bXXXXXPu_WXXXXXYgcA==.mp4",
"caption": "Teste",
"mimeType": "video/mp4"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": true,
"chatLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1779134507000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": null,
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": "3EB054C12BAAC70228AAB6",
"messageExpirationSeconds": 0,
"forwarded": false,
"type": "ReceivedCallback",
"fromApi": false,
"text": {
"message": "test"
},
"statusAudio": {
"audioUrl": "https://f004.backblazeb2.com/file/temp-file-download/instances/3FXXXXXXXXXXXXXXXXXXXXXXXF/3XXXXXXXXXXXXXXXX64/dXXXXXXXXXXXXXXXXQ==.ogg",
"mimeType": "audio/ogg; codecs=opus"
}
}
```
### Broadcast list
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"chatLid": null,
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "3C67AB641C8AA0412F6A2242B4E23AC7",
"messageId": "702CC5F7E0A6BF4421",
"phone": "1774895799-broadcast",
"fromMe": true,
"momment": 1774895725000,
"status": "RECEIVED",
"broadcast": true,
"type": "ReceivedCallback",
"broadcastRecipients": ["126104585119999", "138955211189999"],
"text": {
"message": "Broadcast list message test"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"momment": 1736797729000,
"status": "RECEIVED",
"fromMe": true,
"phone": "5544999999999",
"chatName": "chat",
"type": "ReceivedCallback",
"waitingMessage": true,
"viewOnce": true
}
```
***
## Notifications
In addition to messages, the webhook also receives call, group, and account notifications.
### Calls
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "1779374011-59",
"phone": "999999999999@lid",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374147000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_RECEIVED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "1779374011-59",
"phone": "999999999999@lid",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374147000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_MISSED_VOICE",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "3EDCD745FEB360458A8DBAA76574573D",
"messageId": "1779374011-52",
"phone": "999999999999@lid",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374129000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_MISSED_VIDEO",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": true
}
```
### Calls with enabled and contracted call functionality
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "F44E0E2011E7C784BB9A4AC11749C436",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374642000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_RECEIVED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "F44E0E2011E7C784BB9A4AC11749C436",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374642000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_ACCEPTED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "F44E0E2011E7C784BB9A4AC11749C436",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374642000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_STARTED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "F44E0E2011E7C784BB9A4AC11749C436",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374642000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_ENDED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "F44E0E2011E7C784BB9A4AC11749C436",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374642000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_MISSED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": false
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"chatLid": "999999999999@lid",
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "F44E0E2011E7C784BB9A4AC11749C436",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": false,
"fromApi": false,
"momment": 1779374642000,
"expiresAt": null,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"participantLid": null,
"referenceMessageId": null,
"externalAdReply": null,
"forwarded": false,
"type": "ReceivedCallback",
"notification": "CALL_MISSED",
"notificationParameters": [],
"callId": "F44E0E2011E7C784BB9A4AC11749C436",
"code": null,
"callDirection": "incoming",
"isVideo": true
}
```
### Groups
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999-group",
"connectedPhone": "5544999999999",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"type": "ReceivedCallback",
"notification": "MEMBERSHIP_APPROVAL_REQUEST",
"notificationParameters": ["5544999999999"],
"requestMethod": "invite_link"
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999-group",
"connectedPhone": "5544999999999",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"type": "ReceivedCallback",
"notification": "REVOKED_MEMBERSHIP_REQUESTS",
"notificationParameters": ["5544999999999"]
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isGroup": true,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999-group",
"connectedPhone": "5544999999999",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"type": "ReceivedCallback",
"notification": "MEMBERSHIP_APPROVAL_REQUEST",
"notificationParameters": ["5544999999999", "5544888888888"],
"requestMethod": "non_admin_add"
}
```
### Channels
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"fromMe": false,
"momment": 1632228925000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"participantPhone": null,
"participantLid": null,
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"newsletterAdminInvite": {
"newsletterId": "120363166555745933@newsletter",
"newsletterName": "Test",
"text": "I want to invite you to be an admin of my channel",
"inviteExpiration": 1706809668
}
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "464201093",
"phone": "5544999999999@newsletter",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"notification": "NEWSLETTER_ADMIN_PROMOTE",
"notificationParameters": ["5544999999999", "ADMIN"]
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isStatusReply": false,
"senderLid": "81896604192873@lid",
"connectedPhone": "554499999999",
"waitingMessage": false,
"isEdit": false,
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"messageId": "464201093",
"phone": "5544999999999@newsletter",
"fromMe": false,
"momment": 1682017970000,
"status": "RECEIVED",
"chatName": "name",
"senderPhoto": "https://",
"senderName": "name",
"photo": "https://",
"broadcast": false,
"type": "ReceivedCallback",
"notification": "NEWSLETTER_ADMIN_DEMOTE",
"notificationParameters": ["5544999999999", "SUBSCRIBER"]
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": true,
"momment": 1736797729000,
"status": "RECEIVED",
"type": "ReceivedCallback",
"notification": "PROFILE_NAME_UPDATED",
"profileName": "updated name"
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": true,
"momment": 1736797729000,
"status": "RECEIVED",
"type": "ReceivedCallback",
"notification": "PROFILE_PICTURE_UPDATED",
"updatedPhoto": "https://"
}
```
```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
"isGroup": false,
"isNewsletter": false,
"instanceId": "A20DA9C0183A2D35A260F53F5D2B9244",
"phone": "5544999999999",
"connectedPhone": "5544999999999",
"fromMe": true,
"momment": 1736797729000,
"status": "RECEIVED",
"type": "ReceivedCallback",
"notification": "CHAT_LABEL_ASSOCIATION",
"notificationParameters": [
{
"phone": "5544977777777",
"label": "1",
"assigned": true
},
{
"phone": "5544988888888",
"label": "2",
"assigned": false
}
]
}
```
## Notification types
### Concept
Notifications are events sent via webhook that indicate changes or actions on WhatsApp, such as calls, group interactions, and account updates.
These events can be identified by the `notification` attribute present in the payload.
Below are the notification types and their meanings.
### Notifications (webhook events)
Group was created
Group subject was changed
Group description was changed
Group icon was changed
A participant was promoted to admin
A participant was demoted from admin
Participant left the group
Participant was added to the group
Participant was removed from the group
Participant accepted the invite link and joined the group
Missed voice call
Missed video call
Message indicating end-to-end encryption
Message protected by encryption
Business account not verified by WhatsApp
Business account verified by WhatsApp
Business account changed to personal account
Message deleted
Sending the confirmation code for number registration
***