Update a webhook
Partially update a webhook's `url`, `event_types`, `inbox_ids`, and/or `enabled` flag. At least one field must be supplied. `event_types` is **replace-not-merge** — the supplied array becomes the whole filter set. Set `enabled: false` to pause deliveries without deleting the endpoint.
Partially update a webhook's url, event_types, inbox_ids, and/or
enabled flag. At least one field must be supplied. event_types is
replace-not-merge — the supplied array becomes the whole filter set.
Set enabled: false to pause deliveries without deleting the endpoint.
The per-tenant API key. Sent as the x-api-key request header. The key
is tenant-scoped.
In: header
Path Parameters
The webhook's opaque id (e.g. wh_…).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Update-webhook body (partial). Supply at least one field. event_types
is replace-not-merge — the supplied array becomes the whole filter set.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{ "webhook_id": "string", "url": "http://example.com", "event_types": [ "message.received" ], "inbox_ids": [ "string" ], "enabled": true, "client_id": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{ "name": "string", "message": "string"}{ "name": "string", "message": "string"}{ "name": "string", "message": "string"}{ "name": "validation", "errors": { "property1": "string", "property2": "string" }}{ "name": "string", "message": "string"}