Skip to content

Send a workspace test event

Posts a signed webhook.test event to the workspace endpoint.

HTTP request

POST https://www.asqiro.com/api/v1/webhooks/test

An API key created by a workspace member who can edit. A viewer's key answers 403.

Response body

FieldTypeDescription
deliveredbooleanWhether the configured endpoint accepted the test event.
Note The workspace test event carries a null formId, because it belongs to no single survey. Everything else - envelope, headers, signature - matches a real delivery.

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.
  • invalid_request · 400 · The request body or a parameter was missing or malformed. Fix the request; retrying it unchanged will fail again.
  • 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 -X POST "https://www.asqiro.com/api/v1/webhooks/test" \
  -H "Authorization: Bearer $ASQIRO_API_KEY"

Returns 200 on success.

Example response
json
{
  "delivered": true
}