REST API
Create a webhook endpoint
Register a receiver URL for event subscriptions.
POST
/v1/webhooks/endpointsParameters
urlstringrequiredhttps URL of your receiver (port 443 or 8443). It must answer 2xx to the
endpoint.test POST before real events flow.namestringoptionala label for your own reference
clientstringoptionalAGENCIES: the client this endpoint belongs to (defaults to the key’s binding). A subscription can only use an endpoint of its own client or an organization-wide one.
headersobjectoptionalcustom request headers for your receiver’s own auth (authorization, x-api-key, x-*); at most 8, values stored encrypted, shown by name only
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.
Register a receiver URL for event subscriptions. No record cost. Returns the endpoint AND its signing `secret` ONCE — store it; it is never shown again (rotate with update_webhook_endpoint if lost). The endpoint starts `pending`: an `endpoint.test` event is POSTed to it, and a 2xx answer makes it `active`; subscriptions on a pending endpoint queue their matches but deliver nothing. Every request is signed (x-breaknorm-signature; describe_events has the verification snippet). `headers` adds your receiver's own auth header(s). Client binding: as lists — a key bound to a client creates that client's endpoints.
Errors follow one format.