Status Update

Status Update callbacks are triggered to notify your application when a survey's status changes. This includes transitions to completed, failed, expired, or stopped.

Status Update Webhook Payload

Parameter	Type	Required	Description
id	string	true	Unique survey identifier (UUID)
channel	string	true	Always survey
api_version	string	true	API version used for the callback (e.g., 2026-01-01)
callback_type	string	true	Always status_update
status	string	true	Current survey status (pending, completed, failed, expired, or stopped)
type	string	true	Survey type (web or generic)
url	string	false	Shareable survey URL (web surveys only)
tag	string	false	Custom tag provided when the survey was created
bulk_tag	string	false	Bulk tag provided when the survey was created
timestamp	number	true	Time the event occurred, in milliseconds since epoch
error	object	false	Error object, if applicable
error.code	number	false	Numeric error code
error.description	string	false	Human-readable error description
failure_reason	string	false	Reason for failure, if status is failed
response	array	false	All responses collected on the survey at the time of the event
response[].key	string	true	Response key (question identifier)
response[].value	any	true	Response value
response[].answered_at	string	true	ISO 8601 datetime when the response was first recorded