Skip to main content
POST
/
webhooks
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "events": [
    "<string>"
  ],
  "secret": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.quantumapi.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication. Format: Bearer {key_id}:{secret}

Headers

​
Idempotency-Key
string

Idempotency key for safe retries (required for POST/PUT)

Body

application/json
​
url
string<uri>
required
​
events
string[]

Event types to subscribe to (empty = all)

Response

201 - application/json

Webhook endpoint created (includes secret)

​
id
string<uuid>
required
​
tenantId
string<uuid>
required
​
url
string<uri>
required
​
status
enum<string>
required
Available options:
ACTIVE,
DISABLED
​
createdAt
string<date-time>
required
​
events
string[]
​
secret
string

Only returned on creation