Sign in

v11

OpenAPI 3.1.02026-08-0364112112.3 KB
Webhooks

Create a webhook subscriptions

Create a webhook subscriptions

post/v1/webhooks

Request body

event'account.created' | 'account.updated' | 'conversation.created' | 'conversation.agent' | 'conversation.tags' | 'conversation.custom_fields' | 'conversation.status' | 'conversation.priority' | 'conversation.message' | 'conversation.message.delivery_status' | 'conversation.message.deprecated' | 'customer.identify' | 'customer.created' | 'customer.updated' | 'customer.custom_fields' | 'customer.notes' | 'customer.notes.deleted' | 'session.finished' | 'sidebar.sent' | 'sidebar.received' required
endpointstring uri required

Example request

{
  "endpoint": "http://www.example.com/"
}

Response

Successful Response

idstring uuid required
companyIdstring uuid required
event'account.created' | 'account.updated' | 'conversation.created' | 'conversation.agent' | 'conversation.tags' | 'conversation.custom_fields' | 'conversation.status' | 'conversation.priority' | 'conversation.message' | 'conversation.message.delivery_status' | 'conversation.message.deprecated' | 'customer.identify' | 'customer.created' | 'customer.updated' | 'customer.custom_fields' | 'customer.notes' | 'customer.notes.deleted' | 'session.finished' | 'sidebar.sent' | 'sidebar.received' required
endpointstring uri required
endpointKeystring required
status'ACTIVE' | 'INACTIVE' required
signingSecretstring required

Example response

{
  "endpoint": "http://www.example.com/"
}