API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Webhooks

Get all webhooks

webhooks.list() -> WebhookListResponse

get/api/v2/account/webhooks

Add new webhooks

webhooks.create(WebhookCreateParams**kwargs) -> WebhookCreateResponse

post/api/v2/account/webhooks

Replace all webhooks

webhooks.update(WebhookUpdateParams**kwargs) -> WebhookUpdateResponse

put/api/v2/account/webhooks

Delete specific webhooks

webhooks.delete(WebhookDeleteParams**kwargs) -> WebhookDeleteResponse

delete/api/v2/account/webhooks

ModelsExpand Collapse

class WebhookConfiguration: …

call_log: Optional[List[CallLog]]

Webhooks for call logs

Accepts one of the following:

CallLogUnionMember0 = str

Simple webhook URL (HTTPS only)

class CallLogWebhookObject: …

url: str

Webhook URL (HTTPS only)

formaturi

secret: Optional[str]

Secret for webhook verification

contact_created: Optional[List[str]]

Webhooks for contact creation (URL strings only)

global_secret: Optional[str]

Global secret applied to all webhooks

line_assigned: Optional[List[LineAssigned]]

Webhooks for line assignment

Accepts one of the following:

LineAssignedUnionMember0 = str

Simple webhook URL (HTTPS only)

class LineAssignedWebhookObject: …

url: str

Webhook URL (HTTPS only)

formaturi

secret: Optional[str]

Secret for webhook verification

line_blocked: Optional[List[LineBlocked]]

Webhooks for blocked lines

Accepts one of the following:

LineBlockedUnionMember0 = str

Simple webhook URL (HTTPS only)

class LineBlockedWebhookObject: …

url: str

Webhook URL (HTTPS only)

formaturi

secret: Optional[str]

Secret for webhook verification

outbound: Optional[List[Outbound]]

Webhooks for outbound messages

Accepts one of the following:

OutboundUnionMember0 = str

Simple webhook URL (HTTPS only)

class OutboundWebhookObject: …

url: str

Webhook URL (HTTPS only)

formaturi

secret: Optional[str]

Secret for webhook verification

receive: Optional[List[Receive]]

Webhooks for inbound messages

Accepts one of the following:

ReceiveUnionMember0 = str

Simple webhook URL (HTTPS only)

class ReceiveWebhookObject: …

url: str

Webhook URL (HTTPS only)

formaturi

secret: Optional[str]

Secret for webhook verification

secret: Optional[str]

Legacy secret field