Sign in

v1

latestOpenAPI 3.1.02026-07-14220425.8 KB

Submission Webhook

Get submission creation, completion, expiration, and archiving notifications using these events: <ul><li><strong>'submission.created'</strong> event is triggered when the submission is created.</li><li><strong>'submission.completed'</strong> event is triggered when the submission is completed by all signing parties.</li><li><strong>'submission.expired'</strong> event is triggered when the submission expires.</li><li><strong>'submission.archived'</strong> event is triggered when the submission is archived.</li> </ul>

postWebhooksubmissionWebhook

Payload

event_type'submission.created' | 'submission.completed' | 'submission.expired' | 'submission.archived'

The event type.

timestampstring date-time

The event timestamp.

Example payload

{
  "timestamp": "2023-09-24T11:20:42Z",
  "data": {
    "submitters": [
      {
        "email": "john.doe@example.com",
        "phone": "+1234567890",
        "role": "First Party"
      }
    ]
  }
}

Response

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