Create a webhook endpoint
curl --request POST \
--url https://www.qwairy.co/api/v1/webhooks \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"url": "<string>",
"events": [
"<string>"
]
}
'import requests
url = "https://www.qwairy.co/api/v1/webhooks"
payload = {
"url": "<string>",
"events": ["<string>"]
}
headers = {
"Authorization": "<authorization>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({url: '<string>', events: ['<string>']})
};
fetch('https://www.qwairy.co/api/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"secret": "<string>"
}Webhook endpoints
Create a webhook endpoint
Register an HTTPS endpoint for integration webhook events. The signing secret is returned once, in this response only. A team can have 10 endpoints.
POST
https://www.qwairy.co
/
api
/
v1
/
webhooks
Create a webhook endpoint
curl --request POST \
--url https://www.qwairy.co/api/v1/webhooks \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"url": "<string>",
"events": [
"<string>"
]
}
'import requests
url = "https://www.qwairy.co/api/v1/webhooks"
payload = {
"url": "<string>",
"events": ["<string>"]
}
headers = {
"Authorization": "<authorization>",
"Idempotency-Key": "<idempotency-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'Idempotency-Key': '<idempotency-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({url: '<string>', events: ['<string>']})
};
fetch('https://www.qwairy.co/api/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"secret": "<string>"
}Creates an endpoint for the team. The signing secret is returned once, in
this response only. Store it to verify signatures.
A team can have at most 10 endpoints.
Integration webhooks require an active Business, Agency Business or Enterprise plan. Changing an endpoint also requires an API token with write access enabled by an Owner or Manager. See Integration webhooks and Writing data.
The other fields are described in List webhook endpoints.
See Error codes for authentication, plan, idempotency and server errors. A token without write access returns
Unique key for this operation, at most 255 characters. Completed responses replay for 24 hours.
At least one event type:
run.completed,
run.failed, run.cancelled, pitch_audit.completed, pitch_audit.failed,
site_audit.completed, prompt_suggestions.ready, prompt_suggestions.failed
or webhook.test.Limit the endpoint to these workspaces, at most 100. Omit it or send an empty
array to receive the events of every workspace of the team.
Response
Returns201 with Location, ETag and the endpoint, plus the secret.
Signing secret. Shown once; it cannot be read again. Rotate it with
Rotate the signing secret if you lose it.
Synthetic request and response
curl -X POST "https://www.qwairy.co/api/v1/webhooks" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN" \
-H "Idempotency-Key: webhook-endpoint-001" \
-H "Content-Type: application/json" \
-d '{"url":"https://hooks.example.com/qwairy","description":"Production receiver","events":["run.completed","run.failed"]}'
{
"id": "eeeeeeee-0000-4000-8000-000000000000",
"url": "https://hooks.example.com/qwairy",
"description": "Production receiver",
"events": ["run.completed", "run.failed"],
"brandIds": [],
"enabled": true,
"disabledReason": null,
"failingSince": null,
"previousSecretExpiresAt": null,
"version": 0,
"createdAt": "2026-10-12T09:00:00.000Z",
"updatedAt": "2026-10-12T09:00:00.000Z",
"secret": "synthetic-signing-secret"
}
Errors
| Status | Code | Cause |
|---|---|---|
400 | INVALID_REQUEST | Invalid URL, unknown event, or a value out of range |
409 | CONFLICT | The request conflicts with the current endpoints, for example the limit of 10 endpoints |
409 | IDEMPOTENCY_CONFLICT | The key was reused with a different body |
403 API_KEY_READ_ONLY. On 429, honor Retry-After. If the write limiter is unavailable or writes are suspended, the request returns 503 SERVICE_UNAVAILABLE and nothing changes.
