---
title: "Template Webhook"
method: POST
path: "templateWebhook"
---

# Template Webhook

`POST templateWebhook` (webhook)

Get template creation and update notifications using these events: <ul><li><strong>'template.created'</strong> is triggered when the template is created.</li><li><strong>'template.updated'</strong> is triggered when the template is updated.</li><li><strong>'template.archived'</strong> is triggered when the template is archived.</li></ul>

## Payload

- object
  - `event_type` 'template.created' | 'template.updated' | 'template.archived' — The event type.
  - `timestamp` string, date-time — The event timestamp.
  - `data` object — Submitted data object.
    - `id` number — The template's unique identifier.
    - `slug` string — The template's unique slug.
    - `name` string — The template's name.
    - `schema` object[] — The template document files.
      - `attachment_uuid` string — The attachment UUID.
      - `name` string — The attachment name.
    - `fields` object[] — The template fields.
      - `uuid` string — The field UUID.
      - `submitter_uuid` string — The submitter role UUID.
      - `name` string — The field name.
      - `type` 'heading' | 'text' | 'signature' | 'initials' | 'date' | 'number' | 'image' | 'checkbox' | 'multiple' | 'file' | 'radio' | 'select' | 'cells' | 'stamp' | 'payment' | 'phone' | 'verification' | 'kba' | 'strikethrough' — The field type.
      - `required` boolean — The flag indicating whether the field is required.
      - `preferences` object — The field preferences.
      - `areas` object[] — List of areas where the field is located in the document.
        - `x` number — X coordinate of the area where the field is located in the document.
        - `y` number — Y coordinate of the area where the field is located in the document.
        - `w` number — Width of the area where the field is located in the document.
        - `h` number — Height of the area where the field is located in the document.
        - `attachment_uuid` string — Unique identifier of the attached document where the field is located.
        - `page` integer — Page number of the attached document where the field is located.
    - `submitters` object[] — List of submitter roles defined in the template.
      - `name` string — Submitter name.
      - `uuid` string — Unique identifier of the submitter.
    - `author_id` integer — Unique identifier of the author of the template.
    - `archived_at` string, nullable — Date and time when the template was archived.
    - `created_at` string — Date and time when the template was created.
    - `updated_at` string — Date and time when the template was updated.
    - `source` 'native' | 'api' | 'embed' — Source of the template.
    - `external_id` string, nullable — Identifier of the template in the external system.
    - `folder_id` integer — Unique identifier of the folder where the template is placed.
    - `folder_name` string — Folder name where the template is placed.
    - `preferences` object — Template preferences object.
    - `shared_link` boolean — Flag indicating whether the shared link is enabled for the template.
    - `author` object — Author of the template.
      - `id` integer — Unique identifier of the author.
      - `first_name` string — First name of the author.
      - `last_name` string — Last name of the author.
      - `email` string — Author email.
    - `documents` object[] — List of documents attached to the template.
      - `id` integer — Unique identifier of the document.
      - `uuid` string — Unique identifier of the document.
      - `url` string — URL of the document.
      - `preview_image_url` string — Document preview image URL.
      - `filename` string — Document filename.

## Acknowledgement `200`

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

---

[API](https://skmtc.dev/docusealco/apis/docuseal-api.md) · [All operations](https://skmtc.dev/docusealco/apis/docuseal-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/docusealco/docuseal-api/revisions/c209c00c2386/schema)