Create a webhook endpoint (reveal-once secret)

POST 
/api/v1/webhook-endpoints

Required scope: webhook:write. The URL must be https:// and passes an SSRF gate at create time AND a resolve-and-pin check at every delivery. The whsec_ signing secret is returned ONCE (idempotency replays it for 1 hour). Max 10 active endpoints per company. Endpoints are mode-scoped: a sandbox key's endpoints receive only sandbox events.

Request

Responses

201

Reveal-once signing secret.

400

400 — INVALID_JSON, VALIDATION_ERROR, or IDEMPOTENCY_KEY_REQUIRED.

401

401 — INVALID_SIGNATURE or SIGNING_NOT_CONFIGURED (or bearer auth failure).

403

403 — missing scope (FORBIDDEN_SCOPE) or module (FORBIDDEN_MODULE).

422

ENDPOINT_REJECTED — SSRF-gated URL or endpoint cap.

429

429 — RATE_LIMITED (per-key limit, reads and writes alike; fails closed, so a limiter outage also returns 429). A limiter-down 429 is deliberately indistinguishable from a quota 429. Carries Retry-After (seconds).

Response Headers

Retry-After

Seconds to wait before retrying (429 only).

RateLimit-Limit

Per-minute request ceiling for this key's tier.

RateLimit-Remaining

Requests left in the current window (floored at 0).

RateLimit-Reset

Seconds until the window resets.

503

503 — the API is not enabled on this environment (FEATURE_DISABLED).