Delete a webhook
Deletes the webhook and its signing keys. Existing delivery records stay available. An
active delivery finishes before deletion returns. Requires the org:connect:write
permission. Returns 404 when the caller's organization has no webhook with this id.
Authorization
oauth2 Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.
In: header
Path Parameters
Unique identifier of the webhook.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/webhooks/550e8400-e29b-41d4-a716-446655440000"{ "code": "BAD_REQUEST", "description": "Bad Request"}{ "code": "UNAUTHORISED", "description": "Unauthorised"}{ "code": "FORBIDDEN", "description": "Forbidden"}{ "code": "BAD_REQUEST", "description": "Invalid input"}{ "code": "RATE_LIMIT_EXCEEDED", "description": "Too Many Requests"}{ "code": "INTERNAL_ERROR", "description": "Internal Server Error"}Update a webhook PATCH
Changes the URL, status, timeout, or the set of events this webhook receives. `events` is the complete set, so it is also how an event is added or removed. Omitted fields are left as they are. Requires the `org:connect:write` permission. Returns 400 when the URL is invalid or an `events` entry is not in the published vocabulary, 404 when the caller's organization has no webhook with this id, and 409 when the new URL already belongs to another webhook.
Rotate the signing key POST
Mints a second key so a receiver can accept both while it rolls over. Revoke the old key with the revoke a signing key operation once it has. A webhook holds at most two keys, so rotating twice without revoking is a conflict. Requires the `org:connect:write` permission. Returns 404 when the caller's organization has no webhook with this id, and 409 when the webhook already holds the maximum number of keys.