Webhooks
Stay connected in real-time. Set up webhooks to automatically receive instant notifications whenever important events happen in your account.
Configuration & Events
Setting up a webhook is easy! Just head over to your Dashboard, enter your Endpoint URL, and customize the data payload you want to receive using our dynamic tags.
1. Event: whatsapp.message.sent
Get notified the moment a standard text or media message is sent. You can customize the payload to include exactly what you need, like contact details and the message content.
JSON Payload
{
"event": "whatsapp.message.sent",
"timestamp": "[@TOWhatsappMessageId]",
"firmId": "[@TOFirmId]",
"contact": {
"id": "[@TOContactId]",
"name": "[@TOContactFullName]",
"email": "[@TOContactEmail]",
"phone": "[@TOContactPhone]",
"location": {
"city": "[@TOContactAddressCity]",
"state": "[@TOContactAddressState]",
"country": "[@TOContactAddressCountry]"
}
},
"message": {
"id": "[@TOWhatsappMessageId]",
"text": "[@TOWhatsappMessageText]",
"status": "[@TOWhatsappMessageStatus]",
"replyToMessageId": "[@TOWhatsappMessageReplyToMessageId]",
"media": {
"url": "[@TOWhatsappMessageMediaUrl]",
"filename": "[@TOWhatsappMessageMediaFilename]",
"type": "[@TOWhatsappMessageMediaFiletype]",
"size": "[@TOWhatsappMessageMediaFilesize]"
}
}
}2. Event: whatsapp.template.sent
Get notified when one of your pre-approved templates is sent out. This event includes helpful metadata so you always know exactly which template was used.
JSON Payload
{
"event": "whatsapp.template.sent",
"timestamp": "[@TOWhatsappMessageId]",
"firmId": "[@TOFirmId]",
"contact": {
"id": "[@TOContactId]",
"name": "[@TOContactFullName]",
"email": "[@TOContactEmail]",
"phone": "[@TOContactPhone]",
"location": {
"city": "[@TOContactAddressCity]",
"state": "[@TOContactAddressState]",
"country": "[@TOContactAddressCountry]"
}
},
"message": {
"id": "[@TOWhatsappMessageId]",
"text": "[@TOWhatsappMessageText]",
"status": "[@TOWhatsappMessageStatus]",
"replyToMessageId": "[@TOWhatsappMessageReplyToMessageId]",
"media": {
"url": "[@TOWhatsappMessageMediaUrl]",
"filename": "[@TOWhatsappMessageMediaFilename]",
"type": "[@TOWhatsappMessageMediaFiletype]",
"size": "[@TOWhatsappMessageMediaFilesize]"
},
"template": {
"id": "[@TOWhatsappTemplateId]",
"name": "[@TOWhatsappTemplateName]",
"metaName": "[@TOWhatsappMetaTemplateName]",
"language": "[@TOWhatsappTemplateLanguage]",
"category": "[@TOWhatsappTemplateCategory]"
}
}
}