ORorq-ai
Webhooks

Create a webhook

Changed on

Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with GET /v2/webhooks/secret.

post/v2/webhooks

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/webhooks
  • Auth
    HTTP bearer

Request body

_idstring required

Client-generated webhook ID.

urlstring uri required

HTTPS endpoint that receives webhook deliveries.

content_type'application/json' | 'application/x-www-form-urlencoded' required

Content type sent with webhook deliveries.

display_namestring required

Human-readable webhook name.

eventsstring[] required

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

secretstring required

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.

enabledboolean

Whether webhook deliveries are enabled.

Example request

{
  "url": "https://hooks.example.com/webhooks/orq",
  "display_name": "Deployment notifications"
}

Response

OK

_idstring required

Unique webhook ID.

urlstring uri required

HTTPS endpoint that receives webhook deliveries.

content_type'application/json' | 'application/x-www-form-urlencoded' required

Content type sent with webhook deliveries.

display_namestring required

Human-readable webhook name.

eventsstring[] required

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

secretstring required

Signing secret used to compute X-Orq-Signature as the lowercase hexadecimal HMAC-SHA256 of the exact request body bytes. Shown in full only in the create response; list and get return a masked value.

enabledboolean

Whether webhook deliveries are enabled.

failure_countinteger

Server-managed number of consecutive delivery failures.

created_by_idstring required

Account ID that created the webhook.

updated_by_idstring required

Account ID that most recently updated the webhook.

createdstring date-time required

Creation time in RFC 3339 format.

updatedstring date-time required

Most recent update time in RFC 3339 format.

Changes