Get workspace webhook settings
Returns whether a workspace-wide webhook is configured, and its target URL.
HTTP request
GET https://www.asqiro.com/api/v1/webhooks
Any API key in the survey's workspace.
Response body
| Field | Type | Description |
|---|---|---|
| enabled | boolean | Whether a workspace-wide webhook is currently configured. |
| targetUrl | string· nullable | The URL receiving events, or null when no webhook is configured. |
Note There is no workspace id in the path: the API key already identifies one workspace, and these endpoints always act on that one. A key limited to specific surveys cannot use them and answers 403 with the code forbidden.
Errors
- unauthorized · 401 · The API key is missing, malformed, deleted, or its creator lost workspace access. Check the Authorization header, then the key itself.
- forbidden · 403 · The key is valid but lacks the access this call needs - most often a read-only key attempting a write.
- plan_upgrade_required · 403 · The workspace owner's plan does not include API access. Upgrading the plan restores it; retrying will not.
- rate_limited · 429 · Too many requests. The Retry-After response header carries the number of seconds to wait.
Example request
bash
curl "https://www.asqiro.com/api/v1/webhooks" \
-H "Authorization: Bearer $ASQIRO_API_KEY"Returns 200 on success.
json
{
"enabled": true,
"targetUrl": "https://hooks.example.com/asqiro"
}