Register a new webhook subscription.
POST/public/v1/webhooks
Registers a webhook subscription for the calling consumer. Requires the webhooks:manage scope. The target URL is SSRF-guarded at registration: it must be https and must not resolve to loopback, private, link-local, or cloud-metadata addresses. The HMAC signing secret is returned ONCE in the response and is never retrievable again.
Request
Responses
- 201
- 400
- 401
- 403
The webhook was created. The secret field is present only in this response, so capture it now.
Response Headers
Location
Relative path of the created webhook subscription.
The request was malformed (e.g. a non-GUID id or a missing/invalid body).
The X-Api-Key header is missing, unknown, or revoked.
The API key is valid but lacks the required scope for this operation.