Skip to main content
POST
Register webhook
Required scopes:

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
action
string
required

The action that triggers sending a webhook. Possible values include incoming_chat, chat_deactivated, chat_access_updated, chat_transferred, user_added_to_chat, user_removed_from_chat, incoming_event, event_deleted, event_updated, incoming_rich_message_postback, chat_properties_updated, chat_properties_deleted, thread_properties_updated, thread_properties_deleted, event_properties_updated, event_properties_deleted, thread_tagged, thread_untagged, routing_status_set, customer_session_fields_updated, events_marked_as_seen, group_created, group_updated, group_deleted, agent_created, agent_updated, agent_deleted, agent_suspended, agent_unsuspended, agent_approved, bot_created, bot_updated, bot_deleted, auto_accesses_updated, tag_created, tag_deleted, tag_updated, thread_summary_set.

secret_key
string
required

The secret key sent in webhooks to verify the source of a webhook.

url
string
required

The destination URL for the webhook.

Maximum string length: 500
owner_client_id
string
required

The Client ID that will own the webhook. Must be owned by your organization.

type
enum<string>
required

The webhook type.

Available options:
bot,
license
additional_data
string[]

Additional data arriving with the webhook. Possible values: chat_properties, chat_presence_user_ids (all actions except for agent_status_changed, agent_deleted).

description
string

The webhook description.

filters
object

The filters to check if a webhook should be triggered.

Response

200 - application/json

Webhook registered successfully.

id
string

Unique ID of the registered webhook.