Skip to main content
POST
Core - Create webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Configuration used to create a webhook in the current workspace.

_id
string
required

Client-generated webhook ID.

Minimum string length: 1
url
string<uri>
required

HTTPS endpoint that receives webhook deliveries.

Pattern: ^https://
content_type
enum<string>
required

Content type sent with webhook deliveries.

Available options:
application/json,
application/x-www-form-urlencoded
display_name
string
required

Human-readable webhook name.

events
string[]
required

One or more workspace event slugs that trigger a delivery, for example deployment.invoked or llm.response.

Minimum array length: 1
secret
string
required
write-only

Signing secret returned by GET /v2/webhooks/secret. Deliveries set X-Orq-Signature to the lowercase hexadecimal HMAC-SHA256 of the exact request body bytes.

Minimum string length: 1
enabled
boolean

Whether webhook deliveries are enabled.

Response

200 - application/json

OK

A webhook subscription and its delivery configuration. Responses include the signing secret; treat it as sensitive.

_id
string
required

Unique webhook ID.

url
string<uri>
required

HTTPS endpoint that receives webhook deliveries.

Pattern: ^https://
content_type
enum<string>
required

Content type sent with webhook deliveries.

Available options:
application/json,
application/x-www-form-urlencoded
display_name
string
required

Human-readable webhook name.

events
string[]
required

Workspace event slugs that trigger a delivery, for example deployment.invoked or llm.response.

secret
string
required

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.

created_by_id
string
required
read-only

Account ID that created the webhook.

updated_by_id
string
required
read-only

Account ID that most recently updated the webhook.

created
string<date-time>
required
read-only

Creation time in RFC 3339 format.

updated
string<date-time>
required
read-only

Most recent update time in RFC 3339 format.

enabled
boolean

Whether webhook deliveries are enabled.

failure_count
integer<int32>
read-only

Server-managed number of consecutive delivery failures.