Register a webhook endpoint
/v1/webhook-endpoints in the Webhook Endpoints API.
curl -X POST https://api.example.test/v1/webhook-endpoints \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Deploy bot", "url": "https://hooks.example.com/zusegenius", "events": ["project.created", "team.member_joined"] }'Answers 201 with the endpoint and, at the top level beside data, the plaintext signing secret. The token must carry, for every event subscribed, the read ability that event requires; the catalogue lists it per event.
The secret appears once. The plaintext
secret(prefixedwhsec_) appears at the top level of the response only here and on rotate-secret. Subsequent reads never surface it; copy it into your consumer's secret storage immediately.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Header Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesRequiredapplication/json
A webhook endpoint to register: where to post, which events, and how to confine it. The signing secret is minted by Zuse Bifrost and returned once beside the endpoint.
Responses
201Createdapplication/json
201 with the endpoint and a top-level secret.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
404Not foundTENANT_MISMATCHapplication/json
With reason: missing_team_scope when the token carries no team scope.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when url is not https://, points at a private or reserved host, or exceeds 2,048 characters; when events is empty or names an unknown event; when allowed_ips holds an invalid address or range; when name is outside 3 to 100 characters.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on