Update a webhook endpoint
/webhooks/{webhook_id}Updates the URL, subscribed event types, resource filters, description, or status of a webhook endpoint.
Changing status requires the webhooks.activate permission in addition to webhooks.update. A new URL is subject to the same destination restrictions as the create operation.
Send the ETag returned by the retrieve operation in the If-Match header to avoid overwriting changes made since the endpoint was retrieved. If the header is omitted, the update is applied to the current revision.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
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
application/json
curl -X PATCH "https://example.com/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "created_at": "2019-08-24T14:15:22Z", "description": "string", "event_types": [ "string" ], "health": { "consecutive_failures": 0, "dead_24h": 0, "delivered_24h": 0, "failed_24h": 0, "last_failure_at": "2019-08-24T14:15:22Z", "last_success_at": "2019-08-24T14:15:22Z", "pending": 0 }, "id": "string", "max_per_second": 0, "object": "webhook", "payload_version": 0, "resource_filters": {}, "revision": 0, "secret": "string", "status": "active", "timeout_ms": 0, "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com" }}Retrieve a webhook endpoint GET
Retrieves a webhook endpoint, including its current `revision` and a `health` summary for the last 24 hours. The signing secret is never included. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the endpoint to avoid overwriting a newer version.
Delete a webhook endpoint DELETE
Deletes a webhook endpoint so that it no longer receives events. Deliveries that are still pending are canceled. Deliveries that have already completed are not affected.