API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

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