Update a webhook
Change a webhook's endpoint, event or active flag. Send only the fields you are changing — pause deliveries with a body of just `{"is_active": false}`.
Authorization
ApiKey API key issued to the partner, sent with the Bearer prefix — for example: Authorization: Bearer su_key_9f2c4d1ab3….
Keys minted on the live instance are prefixed su_key_ and keys minted on sandbox su_test_key_. The two instances keep separate key tables and separate hosts, so a sandbox key sent to the live host — or the reverse — answers Invalid API key. rather than falling back to the other environment.
In: header
Path Parameters
Public ID of the webhook (whk_…), as returned in the id field of list or create.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Send only the fields you are changing; none is required.
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 '{ "is_active": false }'{ "id": "whk_a1b2c3d4e", "event": "checkout.succeeded", "endpoint_url": "https://partner.example.com/hooks/suqo", "is_active": true, "created_at": "2026-07-03T10:15:00Z"}