Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.questra.ai/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Org-Id: <x-org-id>' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "description": "<string>"
}
'
{
  "id": "<string>",
  "org_id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Org-Id
string
required

The ID of the organization to make requests against. Found on your Settings page.

Body

application/json
​
url
string<uri>
required

The HTTPS URL to deliver events to

​
events
string[]

Event types to subscribe to. Omit or pass an empty array to receive all events.

​
description
string

Optional human-readable label for this webhook

Response

201 - application/json

Webhook created. The secret is only returned here — store it securely.

A registered webhook endpoint

​
id
string
required

Unique webhook ID

​
org_id
string
required

Organization ID this webhook belongs to

​
url
string<uri>
required

The endpoint URL that receives event deliveries

​
events
string[]
required

Event types this webhook subscribes to. Empty array means all events.

​
active
boolean
required

Whether deliveries are enabled

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
secret
string
required

HMAC-SHA256 signing secret. Only returned on create and rotate — store it securely.

​
description
string | null

Optional human-readable label