Skip to content
Get started

Webhooks

List webhooks
client.webhooks.list(WebhookListParams { cursor, enabled, limit, tenant_id } query?, RequestOptionsoptions?): WebhookListResponse { data, limit, next_cursor, 2 more }
GET/v1/webhooks
Create a webhook
client.webhooks.create(WebhookCreateParams { url, enabled, event_types, 2 more } body, RequestOptionsoptions?): WebhookCreateResponse { id, created_at, enabled, 7 more }
POST/v1/webhooks
Get a webhook by ID
client.webhooks.retrieve(stringid, RequestOptionsoptions?): WebhookRetrieveResponse { id, created_at, enabled, 6 more }
GET/v1/webhooks/{id}
Update a webhook
client.webhooks.update(stringid, WebhookUpdateParams { enabled, event_types, signing_key, 2 more } body, RequestOptionsoptions?): WebhookUpdateResponse { id, created_at, enabled, 6 more }
PATCH/v1/webhooks/{id}
Delete a webhook
client.webhooks.delete(stringid, RequestOptionsoptions?): void
DELETE/v1/webhooks/{id}