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

client.webhooks.list(RequestOptionsoptions?): WebhookListResponse { status, webhooks }

GET/api/account/webhooks

Add webhooks

client.webhooks.create(WebhookCreateParams { webhooks, globalSecret, type } body, RequestOptionsoptions?): WebhookCreateResponse { message, status, webhooks }

POST/api/account/webhooks

Replace webhooks

client.webhooks.update(WebhookUpdateParams { webhooks } body, RequestOptionsoptions?): WebhookUpdateResponse { message, status, webhooks }

PUT/api/account/webhooks

Delete webhooks

client.webhooks.delete(WebhookDeleteParams { webhooks, type } body, RequestOptionsoptions?): WebhookDeleteResponse { message, status }

DELETE/api/account/webhooks

ModelsExpand Collapse

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

WebhookListResponse { status, webhooks }

status?: string

webhooks?: Webhooks { call_log, contact_created, globalSecret, 5 more }

call_log?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for call log events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

contact_created?: Array<string>

Webhooks for contact created events (URL strings only)

globalSecret?: string

Global secret applied to all webhooks

line_assigned?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for line assigned events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

line_blocked?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for line blocked events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

outbound?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for outbound message status updates

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

receive?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for inbound message events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

typing_indicator?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for typing indicator events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

WebhookCreateResponse { message, status, webhooks }

message?: string

status?: string

webhooks?: Webhooks { call_log, contact_created, globalSecret, 5 more }

call_log?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for call log events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

contact_created?: Array<string>

Webhooks for contact created events (URL strings only)

globalSecret?: string

Global secret applied to all webhooks

line_assigned?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for line assigned events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

line_blocked?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for line blocked events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

outbound?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for outbound message status updates

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

receive?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for inbound message events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

typing_indicator?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for typing indicator events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

WebhookUpdateResponse { message, status, webhooks }

message?: string

status?: string

webhooks?: Webhooks { call_log, contact_created, globalSecret, 5 more }

call_log?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for call log events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

contact_created?: Array<string>

Webhooks for contact created events (URL strings only)

globalSecret?: string

Global secret applied to all webhooks

line_assigned?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for line assigned events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

line_blocked?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for line blocked events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

outbound?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for outbound message status updates

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

receive?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for inbound message events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

typing_indicator?: Array<string | WebhookConfiguration { url, secret } >

Webhooks for typing indicator events

One of the following:

string

WebhookConfiguration { url, secret }

url: string

Webhook endpoint URL for receiving callbacks

formaturi

secret?: string

Secret for webhook signature verification

WebhookDeleteResponse { message, status }

message?: string

status?: string