List webhooks
GET/v1/webhooks
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200WebhookList400401403404409412413415422428429503
API reference
Webhooks
Event delivery endpoints, signing secrets and delivery history.
Create a webhook
POST/v1/webhooks
Request bodyWebhookCreate
| Field | Type | Required |
|---|---|---|
url | string (uri) | yes |
event_types | array of string | yes |
description | string | no |
Responses
201Webhook400401403404409412413415422428429503
Update a webhook
PATCH/v1/webhooks/{webhook_id}
Parameters
| Field | Type | Required |
|---|---|---|
webhook_idpath | string (uuid) | yes |
Request bodyWebhookUpdate
| Field | Type | Required |
|---|---|---|
url | string (uri) | no |
event_types | array of string | no |
status | enum: disabled, active | no |
Responses
200Webhook400401403404409412413415422428429503
Delete a webhook
DELETE/v1/webhooks/{webhook_id}
Parameters
| Field | Type | Required |
|---|---|---|
webhook_idpath | string (uuid) | yes |
Responses
204400401403404409412413415422428429503
Send a test event
POST/v1/webhooks/{webhook_id}/test
Parameters
| Field | Type | Required |
|---|---|---|
webhook_idpath | string (uuid) | yes |
Responses
202Delivery400401403404409412413415422428429503
Rotate the signing secret
POST/v1/webhooks/{webhook_id}/rotate-secret
Parameters
| Field | Type | Required |
|---|---|---|
webhook_idpath | string (uuid) | yes |
Request bodyReasonAction
| Field | Type | Required |
|---|---|---|
reason_code | string | yes |
note | string | no |
Responses
200SecretIssued400401403404409412413415422428429503
List deliveries
GET/v1/webhooks/{webhook_id}/deliveries
Parameters
| Field | Type | Required |
|---|---|---|
webhook_idpath | string (uuid) | yes |
cursorquery | string | no |
limitquery | integer | no |
Responses
200DeliveryList400401403404409412413415422428429503