API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deliveries

List webhook deliveries

client.webhooks.deliveries.list(stringwebhookID, DeliveryListParams { teamId, after, before, 4 more } params?, RequestOptionsoptions?): DeliveryListResponse { data, next_cursor }

GET/v2/webhooks/{teamId}/{webhookId}/deliveries

Get a delivery

client.webhooks.deliveries.get(stringdeliveryID, DeliveryGetParams { teamId, webhookId } params, RequestOptionsoptions?): WebhookDeliveryDetail { attempt_history }

GET/v2/webhooks/{teamId}/{webhookId}/deliveries/{deliveryId}

ModelsExpand Collapse

DeliveryListResponse { data, next_cursor }

data: Array<WebhookDelivery { created_at, delivery_id, status, 8 more } >

created_at: string

formatdate-time

delivery_id: string

formatuuid

status: "success" | "failed"

One of the following:

"success"

"failed"

type: "delivery" | "verification"

One of the following:

"delivery"

"verification"

webhook_id: string

formatuuid

attempts?: number | null

Number of attempts made so far (including async retries).

event?: string | null

Event name (e.g. webhook.test); verification for handshake runs.

status_code?: number | null

HTTP status of the latest attempt; null on a transport error.

team_id?: string | null

formatuuid

updated_at?: string | null

formatdate-time

url?: string

next_cursor?: string | null

Pass as cursor to fetch the next page; null when there are no more.