Delivery Webhooks API Overview and Guide

This documentation page provides detailed information on the Outbound Message Status Webhook, a vital feature designed to enhance your messaging capabilities by allowing you to track the delivery status of your sent messages programmatically.

Ideal for developers looking to monitor and analyze the delivery performance of their communication campaigns, this webhook facilitates real-time notifications of status changes, from sent to delivered or any errors in between.

Explore the setup guidelines, payload specifications, and example use cases here to fully integrate and utilize this feature in optimizing your messaging strategies.

Signature Header

Dexatel signs every webhook request message sent to the user. The signature of each message is computed using the HMAC_SHA256 hashing algorithm, which takes the payload of the webhook, signs with the secret, and sends the computed hash code in the X-Dexatel-Signature header of the request.

Name	Type	Description
X-Dexatel-Signature	string	X-Dexatel-Signature header

Request Body

POST request payload sent in data property in JSON format

Name	Type	Description
account_id	string	Unique identifier of the account which sent the message
message_id	string	Unique identifier of the message
event	string	Delivery
status	string	Possible Values: • DELIVERED • FAILED, • REJECTED • EXPIRED
channel	string	Possible Values: • SMS • VIBER • WHATSAPP • VOICE • TELEGRAM • G_RCS
to	string	Recipients phone number
mccmnc	string	Recipients mobile country code / mobile network code
price	number	Message price, shown in the account's currency
timestamp	string	The timestamp value of the status update
payload	string	Optional parameter that can be received in delivery webhook, if it was provided within Verification API or Messaging APi request body. Maximum 500 characters.

Request Body Example

POST: {configured url}
X-Dexatel-Signature: tfohtYVSauiKc7jJncqDJ4I4RL6A2AKbCUQL6BfuMtk=
Content-Type: application/json
{
    "data": {
        "account_id": "72e47e47-95b9-41c2-bdcd-55dd9bb04e14",
        "message_id": "e4fb1353-8ded-4ec7-991e-a757ea213106",
        "event": "delivery",
        "status": "delivered",
        "channel": "sms",
        "to": "1222333333",
      	"mccmnc": "310670",
      	"price": 0.123,
        "timestamp": "2022-03-01 13:00:00",
      	"payload": "testing payload"
    }
}