Skip to content

Send a test event

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

HTTP request

POST https://www.asqiro.com/api/v1/surveys/{id}/webhook/test

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

Path parameters

ParameterTypeDescription
idstringThe survey id, as returned by the surveys endpoints.Required

Response body

FieldTypeDescription
deliveredbooleanWhether the configured endpoint accepted the test event.
Note The test event contains its delivery id, timestamp, event type, and survey id only. It never contains an answer or externalUserId. A missing endpoint or any non-2xx response answers 400.

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.
  • not_found · 404 · No survey with that id is reachable by this key. A survey in another workspace answers the same way as one that does not exist.
  • 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/surveys/s_7t2qk8wvbf31/webhook/test" \
  -H "Authorization: Bearer $ASQIRO_API_KEY"

Returns 200 on success.

Example response
json
{
  "delivered": true
}