Webhooks
Manage Webhook clients and subscriptions. Register endpoints to receive real-time HTTP callbacks for events, and review webhook delivery logs.
Configuration & Events
Webhooks are configured directly via the Arthix Dashboard UI. You can define the Endpoint URL, HTTP Method, and the JSON body payload containing dynamic variable tags for different event types.
1. Event: whatsapp.message.sent
Triggered whenever a standard WhatsApp message (text or media) is sent. Configure the payload to include contact details and message contents.
{
"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
Triggered when a pre-approved WhatsApp template is dispatched. The payload includes additional template metadata such as the template name, language, and category.
{
"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]"
}
}
}3. Event: workflow.event
Triggered when a workflow hits a specific webhook node during its execution. This serves as a generic callback to external systems from within an active workflow.
{
"event": "workflow.event"
}