Create a webhook
Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with GET /v2/webhooks/secret.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Configuration used to create a webhook in the current workspace.
Client-generated webhook ID.
1HTTPS endpoint that receives webhook deliveries.
^https://Content type sent with webhook deliveries.
application/json, application/x-www-form-urlencoded Human-readable webhook name.
One or more workspace event slugs that trigger a delivery, for example deployment.invoked or llm.response.
1Signing secret returned by GET /v2/webhooks/secret. Deliveries set X-Orq-Signature to the lowercase hexadecimal HMAC-SHA256 of the exact request body bytes.
1Whether webhook deliveries are enabled.
Response
OK
A webhook subscription and its delivery configuration. Responses include the signing secret; treat it as sensitive.
Unique webhook ID.
HTTPS endpoint that receives webhook deliveries.
^https://Content type sent with webhook deliveries.
application/json, application/x-www-form-urlencoded Human-readable webhook name.
Workspace event slugs that trigger a delivery, for example deployment.invoked or llm.response.
Signing secret used to compute X-Orq-Signature as the lowercase hexadecimal HMAC-SHA256 of the exact request body bytes. Treat this value as sensitive.
Account ID that created the webhook.
Account ID that most recently updated the webhook.
Creation time in RFC 3339 format.
Most recent update time in RFC 3339 format.
Whether webhook deliveries are enabled.
Server-managed number of consecutive delivery failures.