Form request event

Sent to a form request's webhookUrl and to every webhook subscription of the workspace that asked for the event, signed and retried like signingEvent (v1.16.0). form_request.completed carries the values under their semantic identifiers and the links to the signed PDF and the evidence. Other events carry the state only. Deduplicate by eventId.

postWebhookformRequestEvent

Payload

event'form_request.opened' | 'form_request.submitted' | 'form_request.completed' | 'form_request.cancelled' | 'form_request.expired' | 'form_request.failed' required
eventIdstring required
webhookIdstring uuid
formRequestIdstring uuid required
referencestring required
status'scheduled' | 'sent' | 'opened' | 'in_progress' | 'submitted' | 'completed' | 'expired' | 'cancelled' | 'failed' required
occurredAtstring date-time required
visitAtstring date-time nullable
externalIdstring
valuesobject

Response

Acknowledge within 10 seconds.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.