Webhooks are user-defined HTTP callbacks. If the user sets up a webhook for an event, and that event occurs, the platform fires a webhook to inform the user and to get verification. Learn more about webhook and its functions here.
Webhook communication is made by sending an HTTP request from the Dexatel Platform to a user’s application. When an event occurs in the Dexatel Platform an HTTP request, that might contain user data relating to the event, is triggered. This HTTP request is sent to the user’s application’s endpoint. This is the endpoint set by the user for webhook requests to be sent to. The endpoint is often referred to as the webhook URL.
Webhook endpoints are meant to configure the webhooks of the account.
Operation gets the details of the webhook.
Details(see data object below)
|id||string||Unique identifier of the webhook||Optional|
|account_id||string||Unique identifier of the account||Optional|
|url||string||Payload URL to which the webhook request is sent||Optional|
|secret||string||Webhook secret to sign the payload||Optional|
Event type for which the webhook is fired.
• message - the webhook will be fired in case of an inbound message
• delivery - the webhook will be fired in case of an available delivery report
|create_date||string||Creation date of the webhook in UTC, formatted as yyyyMM-dd HH:mm:ss||Optional|
|update_date||string||Update date of the webhook in UTC, formatted as yyyyMM-dd HH:mm:ss||Optional|
Details(see links object below)
|self||string||URL of the webhook||Optional|
|account||string||URL of the account||Optional|
Example of request body
Example of response body
The following error codes are returned in response to a user’s request which contains bad syntax or cannot be fulfilled.
|1201||Webhook is not found|
|1202||No Webhook found for the account|
|1203||'data' is required|
|1204||'data.url' is required|
|1205||data.secret' is required|
|1206||'data.event' is required|
|1207||'data.event' values should be in: [MESSAGE, DELIVERY]|
|1208||'data.url' is too long|