Webhooks
Update a webhook
Change a webhook's endpoint, event or active flag. Pause deliveries by setting `is_active` to false.
Authorization
ApiKey AuthorizationBearer <token>
API key issued to the partner, sent with the Bearer prefix — for example: Authorization: Bearer sk_live_abc123.
In: header
Path Parameters
id*integer
Numeric ID of the webhook, as returned by list or create.
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/webhooks/string/" \ -H "Content-Type: application/json" \ -d '{ "event": "checkout.succeeded", "endpoint_url": "http://example.com" }'{ "id": 12, "event": "checkout.succeeded", "endpoint_url": "https://partner.example.com/hooks/suqo", "is_active": true, "created_at": "2026-07-03T10:15:00Z"}