ORorq-ai
Webhooks

Retrieve a webhook

Changed on

Retrieves a webhook in the current workspace by ID. The signing secret is returned masked; it is only shown in full when the webhook is created.

get/v2/webhooks/{id}

Request

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

Path parameters

idstring required

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

  • 0b4e519a544fRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 732aed62833aRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status