v1

latestOpenAPI 3.1.02026-07-17220542.8 KB

Form Webhook

During the form filling and signing process, 4 types of events may occur and are dispatched at different stages: <ul><li><strong>'form.viewed'</strong> event is triggered when the submitter first opens the form.</li><li><strong>'form.started'</strong> event is triggered when the submitter initiates filling out the form.</li><li><strong>'form.completed'</strong> event is triggered upon successful form completion and signing by one of the parties.</li><li><strong>'form.declined'</strong> event is triggered when a signer declines the submission.</li></ul> It's important to note that each of these events contain information available at the time of dispatch, so some data may be missing or incomplete depending on the specific event. Failed webhook requests (4xx, 5xx) are automatically retried multiple times within 48 hours (every 2^attempt minutes) for all production accounts.<br><b>Related Guides</b><br><a href="https://www.docuseal.com/guides/download-signed-documents" class="link">Download Signed Documents</a>

postWebhookformWebhook

Payload

event_type'form.viewed' | 'form.started' | 'form.completed' | 'form.declined'

The event type.

timestampstring date-time

The event timestamp.

Example payload

{
  "timestamp": "2023-09-24T11:20:42Z",
  "data": {
    "email": "john.doe@example.com",
    "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36",
    "phone": "+1234567890",
    "role": "First Party"
  }
}

Response

Return a 200 response to acknowledge successful receipt of the webhook event.