---
title: "Submission Webhook"
method: POST
path: "submissionWebhook"
---

# Submission Webhook

`POST submissionWebhook` (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>

## Payload

- object
  - `event_type` 'submission.created' | 'submission.completed' | 'submission.expired' | 'submission.archived' — The event type.
  - `timestamp` string, date-time — The event timestamp.
  - `data` object — Submitted data object.
    - `id` number — The submission's unique identifier.
    - `name` string — Name of the document submission.
    - `slug` string — Unique slug of the submission.
    - `expire_at` string, nullable — The date and time when the submission will expire.
    - `archived_at` string, nullable — The submission archive date.
    - `created_at` string — The submission creation date.
    - `updated_at` string — The submission update date.
    - `source` 'invite' | 'bulk' | 'api' | 'embed' | 'link' — The submission source.
    - `submitters_order` 'random' | 'preserved' — The submitters order.
    - `audit_log_url` string, nullable — Audit log file URL.
    - `combined_document_url` string, nullable — Combined PDF file URL with documents and Audit Log.
    - `submitters` object[] — The list of submitters for the submission.
      - `id` number — The submitter's unique identifier.
      - `submission_id` number — The unique submission identifier.
      - `uuid` string — The submitter UUID.
      - `email` string, email — The email address of the submitter.
      - `slug` string — The unique slug of the document template.
      - `sent_at` string, nullable — The date and time when the signing request was sent to the submitter.
      - `opened_at` string, nullable — The date and time when the submitter opened the signing form.
      - `completed_at` string, nullable — The date and time when the submitter completed the signing form.
      - `declined_at` string, nullable — The date and time when the submitter declined the signing form.
      - `created_at` string — The date and time when the submitter was created.
      - `updated_at` string — The date and time when the submitter was last updated.
      - `name` string, nullable — The name of the submitter.
      - `phone` string, nullable — The phone number of the submitter, formatted according to the E.164 standard.
      - `role` string — The role name or title of the submitter.
      - `external_id` string, nullable — Your application-specific unique string key to identify this submitter within your app.
      - `metadata` object — Metadata object with additional submitter information.
      - `status` 'completed' | 'declined' | 'opened' | 'sent' | 'awaiting' — The submitter status.
      - `values` object — An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param.
      - `documents` object[] — The list of documents for the submission.
        - `name` string — The document file name.
        - `url` string — The document file URL.
      - `preferences` object — The submitter preferences.
    - `template` object — Base template details.
      - `id` number — The template's unique identifier.
      - `name` string — The template's name.
      - `external_id` string — Your application-specific unique string key to identify template within your app.
      - `folder_name` string — The folder name.
      - `created_at` string — The date and time when the template was created.
      - `updated_at` string — The date and time when the template was last updated.
    - `variables` object — Dynamic content variables object.
    - `created_by_user` object — User who created the submission.
      - `id` integer — Unique identifier of the user who created the submission.
      - `first_name` string — The first name of the user who created the submission.
      - `last_name` string — The last name of the user who created the submission.
      - `email` string — The email address of the user who created the submission.
    - `submission_events` object[] — List of submission events.
      - `id` integer — Submission event unique ID number.
      - `submitter_id` integer — Unique identifier of the submitter that triggered the event.
      - `event_type` 'send_email' | 'bounce_email' | 'complaint_email' | 'send_reminder_email' | 'send_sms' | 'send_2fa_sms' | 'open_email' | 'click_email' | 'click_sms' | 'phone_verified' | 'start_form' | 'start_verification' | 'complete_verification' | 'view_form' | 'invite_party' | 'complete_form' | 'decline_form' | 'api_complete_form' — Event type.
      - `event_timestamp` string — Date and time when the event was triggered.
      - `data` object — Additional event details object.
    - `documents` object[]
      - `name` string — Document name.
      - `url` string — Document URL.
    - `status` 'completed' | 'declined' | 'expired' | 'pending' — The status of the submission.
    - `completed_at` string — The date and time when the submission was fully completed.

## Acknowledgement `200`

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

---

[API](https://skmtc.dev/keyring-network/apis/keyring-docsign-api.md) · [All operations](https://skmtc.dev/keyring-network/apis/keyring-docsign-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/keyring-network/keyring-docsign-api/revisions/5381dc74855a/schema)