API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Webhooks

Get all webhooks

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

get/api/v2/account/webhooks

Add new webhooks

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

post/api/v2/account/webhooks

Replace all webhooks

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

put/api/v2/account/webhooks

Delete specific webhooks

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

delete/api/v2/account/webhooks

ModelsExpand Collapse

WebhookConfiguration { call_log, contact_created, globalSecret, 5 more }

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

Webhooks for call logs

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

contact_created?: Array<string>

Webhooks for contact creation (URL strings only)

globalSecret?: string

Global secret applied to all webhooks

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

Webhooks for line assignment

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

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

Webhooks for blocked lines

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

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

Webhooks for outbound messages

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

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

Webhooks for inbound messages

Accepts one of the following:

string

WebhookObject { url, secret }

url: string

Webhook URL (HTTPS only)

formaturi

secret?: string

Secret for webhook verification

secret?: string

Legacy secret field