API Reference

Stream

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

View webhooks

client.stream.webhooks.get(WebhookGetParams { account_id } params?, RequestOptionsoptions?): WebhookGetResponse { modified, notification_url, notificationUrl, secret }

GET/accounts/{account_id}/stream/webhook

Create webhooks

client.stream.webhooks.update(WebhookUpdateParams { account_id, notification_url, notificationUrl } params?, RequestOptionsoptions?): WebhookUpdateResponse { modified, notification_url, notificationUrl, secret }

PUT/accounts/{account_id}/stream/webhook

Delete webhooks

client.stream.webhooks.delete(WebhookDeleteParams { account_id } params?, RequestOptionsoptions?): WebhookDeleteResponse

DELETE/accounts/{account_id}/stream/webhook

ModelsExpand Collapse

WebhookGetResponse { modified, notification_url, notificationUrl, secret }

modified?: string

The date and time the webhook was last modified.

formatdate-time

notification_url?: string

The URL where webhooks will be sent.

formaturi

notificationUrl?: string

The URL where webhooks will be sent.

formaturi

secret?: string

The secret used to verify webhook signatures.

WebhookUpdateResponse { modified, notification_url, notificationUrl, secret }

modified?: string

The date and time the webhook was last modified.

formatdate-time

notification_url?: string

The URL where webhooks will be sent.

formaturi

notificationUrl?: string

The URL where webhooks will be sent.

formaturi

secret?: string

The secret used to verify webhook signatures.

WebhookDeleteResponse = string