Skip to main content
POST
/
api
/
v1
/
webhooks
Register a webhook
curl --request POST \
  --url https://quizquail.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "events": [
    "render.completed",
    "youtube.uploaded"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "secret": "whsec_abc123..."
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Prefix your key with Bearer in the Authorization header.

Keys follow the format qq_... and can be scoped to specific permissions.

Body

application/json
​
url
string<uri>
required
Example:

"https://example.com/webhook"

​
events
string[]
required

Event types to subscribe to

Minimum array length: 1
Example:
["render.completed", "youtube.uploaded"]

Response

Registered webhook (includes secret)

​
data
object
required