Webhooks
Update a webhook
Change a webhook's URL, events, or turn it on and off.
PATCH
/v1/webhooks/{id}API keySend only the fields you want to change. Fields you leave out keep their value. The secret does not change; use Rotate secret for that.
Setting enabled to false stops new deliveries. Deliveries that were already queued are marked failed with the response body webhook disabled when their turn comes.
Path parameters
The webhook ID.
Body parameters
urlstring
A new http:// or https:// endpoint.
eventsstring[]
Replaces the whole list. At least one entry. Use ["*"] for every event type. See Create a webhook for the allowed values.
enabledboolean
false pauses the webhook, true resumes it.
Response
The updated webhook, without its secret. Same fields as Retrieve a webhook.
Errors
| Status | Code | When |
|---|---|---|
| 400 | missing_body | The request has no body. |
| 400 | invalid_body | A field is malformed. param names the field. |
| 404 | webhook_not_found | No webhook with this ID in the project. |