Skip to content
  • Auto
  • Light
  • Dark
Get Started
View as Markdown
Copy Markdown

Open in Claude
Open in ChatGPT

Webhooks

Get all webhooks
get/api/v2/account/webhooks
Add new webhooks
post/api/v2/account/webhooks
Replace all webhooks
put/api/v2/account/webhooks
Delete specific webhooks
delete/api/v2/account/webhooks
ModelsExpand Collapse
WebhookConfiguration = object { call_log, contact_created, globalSecret, 5 more }
call_log: optional array of string or object { url, secret }

Webhooks for call logs

Accepts one of the following:
UnionMember0 = string

Simple webhook URL (HTTPS only)

WebhookObject = object { url, secret }
url: string

Webhook URL (HTTPS only)

formaturi
secret: optional string

Secret for webhook verification

contact_created: optional array of string

Webhooks for contact creation (URL strings only)

globalSecret: optional string

Global secret applied to all webhooks

line_assigned: optional array of string or object { url, secret }

Webhooks for line assignment

Accepts one of the following:
UnionMember0 = string

Simple webhook URL (HTTPS only)

WebhookObject = object { url, secret }
url: string

Webhook URL (HTTPS only)

formaturi
secret: optional string

Secret for webhook verification

line_blocked: optional array of string or object { url, secret }

Webhooks for blocked lines

Accepts one of the following:
UnionMember0 = string

Simple webhook URL (HTTPS only)

WebhookObject = object { url, secret }
url: string

Webhook URL (HTTPS only)

formaturi
secret: optional string

Secret for webhook verification

outbound: optional array of string or object { url, secret }

Webhooks for outbound messages

Accepts one of the following:
UnionMember0 = string

Simple webhook URL (HTTPS only)

WebhookObject = object { url, secret }
url: string

Webhook URL (HTTPS only)

formaturi
secret: optional string

Secret for webhook verification

receive: optional array of string or object { url, secret }

Webhooks for inbound messages

Accepts one of the following:
UnionMember0 = string

Simple webhook URL (HTTPS only)

WebhookObject = object { url, secret }
url: string

Webhook URL (HTTPS only)

formaturi
secret: optional string

Secret for webhook verification

secret: optional string

Legacy secret field