API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

Operations for managing webhook subscriptions

Get webhooks

GET/api/account/webhooks

Add webhooks

POST/api/account/webhooks

Replace webhooks

PUT/api/account/webhooks

Delete webhooks

DELETE/api/account/webhooks

ModelsExpand Collapse

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

WebhookListResponse object { status, webhooks }

status: optional string

webhooks: optional object { call_log, contact_created, globalSecret, 5 more }

call_log: optional array of string or WebhookConfiguration { url, secret }

Webhooks for call log events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

contact_created: optional array of string

Webhooks for contact created events (URL strings only)

globalSecret: optional string

Global secret applied to all webhooks

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

Webhooks for line assigned events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for line blocked events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for outbound message status updates

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for inbound message events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

typing_indicator: optional array of string or WebhookConfiguration { url, secret }

Webhooks for typing indicator events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

WebhookCreateResponse object { message, status, webhooks }

message: optional string

status: optional string

webhooks: optional object { call_log, contact_created, globalSecret, 5 more }

call_log: optional array of string or WebhookConfiguration { url, secret }

Webhooks for call log events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

contact_created: optional array of string

Webhooks for contact created events (URL strings only)

globalSecret: optional string

Global secret applied to all webhooks

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

Webhooks for line assigned events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for line blocked events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for outbound message status updates

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for inbound message events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

typing_indicator: optional array of string or WebhookConfiguration { url, secret }

Webhooks for typing indicator events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

WebhookUpdateResponse object { message, status, webhooks }

message: optional string

status: optional string

webhooks: optional object { call_log, contact_created, globalSecret, 5 more }

call_log: optional array of string or WebhookConfiguration { url, secret }

Webhooks for call log events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

contact_created: optional array of string

Webhooks for contact created events (URL strings only)

globalSecret: optional string

Global secret applied to all webhooks

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

Webhooks for line assigned events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for line blocked events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for outbound message status updates

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

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

Webhooks for inbound message events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

typing_indicator: optional array of string or WebhookConfiguration { url, secret }

Webhooks for typing indicator events

One of the following:

string

WebhookConfiguration object { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret: optional string

Secret for webhook signature verification

WebhookDeleteResponse object { message, status }

message: optional string

status: optional string