The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique objectId (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a url is provided, which offers a user interface for editing the template and facilitating document distribution.
Tip: Upload your PDF document to our Debug UI, where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API.
When document is created this webhook event will trigger
-{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE",
"url": "SIGNING_URL"
}
],
"createdAt": "TIMESTAMP"
}
{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE",
"url": "SIGNING_URL"
}
],
"createdAt": "TIMESTAMP"
}
Supported Widgets:
Below are the common parameters that are required with all widgets:
{
"event": "viewed",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"viewedBy": "SIGNER_EMAIL",
"viewedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
{
"event": "viewed",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"viewedBy": "SIGNER_EMAIL",
"viewedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
2. created:
{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"createdAt": "TIMESTAMP"
}
{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"createdAt": "TIMESTAMP"
}
{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE",
"url": "SIGNING_URL"
}
],
"createdAt": "TIMESTAMP"
}
{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE",
"url": "SIGNING_URL"
}
],
"createdAt": "TIMESTAMP"
}
3. signed:
{
"event": "signed",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signer": {
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
},
"signedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
{
"event": "signed",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signer": {
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
},
"signedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
4. completed:
{
"event": "completed",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"certificate": "CERTIFICATE_URL",
"completedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
{
"event": "completed",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"certificate": "CERTIFICATE_URL",
"completedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
5. declined:
{
"event": "declined",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"declinedBy": "SIGNER_EMAIL",
"declinedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}
{
"event": "declined",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"description": "",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE"
}
],
"declinedBy": "SIGNER_EMAIL",
"declinedAt": "TIMESTAMP",
"createdAt": "TIMESTAMP"
}