Skip to Content
API & MCPPOSTUpdate a webhook endpoint

REST API

Update a webhook endpoint

Change an endpoint.

POST/v1/webhooks/endpoints/:endpoint_id
MCP tool update_webhook_endpointscope webhooks:writeNo record cost

Parameters

endpoint_idstringrequired
status"active" | "paused"optional
urlstringoptional
https URL of your receiver (port 443 or 8443). It must answer 2xx to the endpoint.test POST before real events flow.
namestringoptional
headersobjectoptional
custom request headers for your receiver’s own auth (authorization, x-api-key, x-*); at most 8, values stored encrypted, shown by name only
rotate_secretbooleanoptional
true = issue a new signing secret (returned once); the previous one stays valid for 24 h

What your agent reads

The tool description exactly as an MCP client receives it in tools/list — it doubles as the full behaviour of the endpoint.

Change an endpoint. No record cost. `status`: 'paused' stops deliveries (matches queue), 'active' resumes a paused endpoint and resets its breaker — a `pending` endpoint cannot be activated by hand, it must answer 2xx to its test event. A new `url` sets the endpoint back to `pending` and sends a new `endpoint.test`. `headers` replaces the custom headers. `rotate_secret: true` returns a NEW secret once; the old one keeps verifying for 24 hours.

Errors follow one format.

GETList webhook endpointsDELDelete a webhook endpoint