Skip to main content

webhook

idnumber

The ID of the webhook

urlstring

The url to which the events will be send

namestring

The name of the webhook

subscriptionsstring[]

The list of subscribed events

Possible values: [conversation_created, conversation_status_changed, conversation_updated, contact_created, contact_updated, message_created, message_updated, webwidget_triggered, conversation_typing_on, conversation_typing_off]

secretstringnullable

Secret used to sign webhook requests. Signed webhook deliveries include X-AzChat-Timestamp and X-AzChat-Signature; the signature is sha256= followed by the HMAC-SHA256 of {timestamp}.{raw_request_body} using this secret. Deliveries also include X-AzChat-Delivery when a delivery id is available.

account_idnumber

The id of the account which the webhook object belongs to

webhook
{
"id": 0,
"url": "string",
"name": "string",
"subscriptions": [
"conversation_created"
],
"secret": "string",
"account_id": 0
}