Pause new event deliveries to the specified Endpoint while preserving its configuration.
Webhook is currently in Beta. APIs, fields, and behavior may change in future versions.
POST /api/v1/forward/webhook/endpoints/{endpoint_id}/disable
Calling this API when the Endpoint is already disabled still returns its current state. Deliveries that began before disabling may still arrive; continue to use Webhook-ID for idempotent processing.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or administrator SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | Yes | Webhook Endpoint ID. |
Example request
Example response
HTTP 200 OK
Returns the complete Endpoint object after the state change, including:
Errors
| HTTP | Type | Trigger |
|---|---|---|
401 | authentication_error | Authentication is missing, invalid, or expired. |
403 | permission_error | The current token cannot manage Webhooks. |
404 | not_found_error | The Endpoint does not exist or is not visible to the current account. |
500/502/503 | api_error | The service is temporarily unavailable. |

