From 01638aa4e73a01f8677f9c2549907bc13e9f6b68 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 19 Dec 2024 13:43:31 +0000 Subject: [PATCH] deploy: e0249211d27d086af91c8b1efccca5c313b96f66 --- 404.html | 2 +- assets/js/0028a090.42c39ba6.js | 1 - assets/js/0028a090.50bb866e.js | 1 + assets/js/2c586be5.1ed86312.js | 1 + assets/js/2c586be5.a184f1a5.js | 1 - assets/js/70853c19.44854024.js | 1 - assets/js/70853c19.ce18ae1a.js | 1 + assets/js/ae010e44.00fb612b.js | 1 - assets/js/ae010e44.595cd5c0.js | 1 + assets/js/bbdfc22d.636268e6.js | 1 + assets/js/bbdfc22d.d9da916d.js | 1 - ...me~main.235362e9.js => runtime~main.f0e932ef.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 9 ++++++--- .../createdocumentwithtemplateid/index.html | 2 +- docs/API-docs/createfolder/index.html | 2 +- docs/API-docs/createtemplate/index.html | 11 +++++++---- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/delete-webhook/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/deletefolder/index.html | 2 +- docs/API-docs/drafttemplate/index.html | 13 +++++++++---- docs/API-docs/folderlist/index.html | 2 +- docs/API-docs/get-template/index.html | 2 +- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/get-webhook/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 2 +- docs/API-docs/getdocumentlist/index.html | 2 +- docs/API-docs/getfolder/index.html | 2 +- docs/API-docs/gettemplatelist/index.html | 2 +- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/resendrequestmail/index.html | 2 +- docs/API-docs/save-update-webhook/index.html | 9 ++++++++- docs/API-docs/selfsign/index.html | 7 ++++--- docs/API-docs/update-document/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/API-docs/updatefolder/index.html | 2 +- docs/category/cloud-storage/index.html | 2 +- .../create-new-opensign-document/index.html | 2 +- docs/category/docker/index.html | 2 +- docs/category/faqs/index.html | 2 +- docs/category/guides/index.html | 2 +- .../manage-docs-using-opensign-drive/index.html | 2 +- docs/category/reports/index.html | 2 +- docs/category/settings/index.html | 2 +- docs/category/templates/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- .../index.html | 2 +- docs/help/FAQs/index.html | 2 +- .../enforce-email-verification/index.html | 2 +- .../New-Document/navigate-between-pages/index.html | 2 +- .../help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- .../help/OpenSign™ Drive/create-document/index.html | 2 +- docs/help/OpenSign™ Drive/list-grid-view/index.html | 2 +- .../OpenSign™ Drive/organize-documents/index.html | 2 +- .../help/OpenSign™ Drive/rename-document/index.html | 2 +- docs/help/Reports/completed/index.html | 2 +- docs/help/Reports/contactbook/index.html | 2 +- docs/help/Reports/declined/index.html | 2 +- docs/help/Reports/drafts/index.html | 2 +- docs/help/Reports/expired/index.html | 2 +- docs/help/Reports/in-progress/index.html | 2 +- docs/help/Reports/need-your-sign/index.html | 2 +- docs/help/Settings/disabledocumentid/index.html | 2 +- docs/help/Settings/manage-users/index.html | 2 +- docs/help/Settings/my-signature/index.html | 2 +- docs/help/Templates/create-template/index.html | 2 +- docs/help/Templates/embed-template/index.html | 2 +- docs/help/Templates/publicTemplate/index.html | 2 +- docs/help/Templates/quick-send/index.html | 2 +- docs/help/Templates/use-template/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- .../One-click-Install/DigitalOcean/index.html | 2 +- docs/self-host/cloud-storage/s3/index.html | 2 +- docs/self-host/docker/run-locally/index.html | 2 +- docs/self-host/docker/upgrade-deployment/index.html | 2 +- docs/self-host/guides/env-variables/index.html | 2 +- .../index.html | 2 +- docs/self-host/guides/upgrade-to-v2.1.0/index.html | 2 +- docs/self-host/intro/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 103 files changed, 127 insertions(+), 108 deletions(-) delete mode 100644 assets/js/0028a090.42c39ba6.js create mode 100644 assets/js/0028a090.50bb866e.js create mode 100644 assets/js/2c586be5.1ed86312.js delete mode 100644 assets/js/2c586be5.a184f1a5.js delete mode 100644 assets/js/70853c19.44854024.js create mode 100644 assets/js/70853c19.ce18ae1a.js delete mode 100644 assets/js/ae010e44.00fb612b.js create mode 100644 assets/js/ae010e44.595cd5c0.js create mode 100644 assets/js/bbdfc22d.636268e6.js delete mode 100644 assets/js/bbdfc22d.d9da916d.js rename assets/js/{runtime~main.235362e9.js => runtime~main.f0e932ef.js} (96%) diff --git a/404.html b/404.html index 34b356f9f..58faf3c4c 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "textbox",
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"name": "textbox",
"required": true,
"readonly": false,
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"readonly": false,
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "textbox",
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"name": "textbox",
"required": true,
"readonly": false,
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"readonly": false,
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
POST/drafttemplate
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",
"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:
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "textbox",
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"name": "textbox",
"required": true,
"readonly": false,
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"readonly": false,
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"event": "created",
"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",
"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"
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "textbox",
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"name": "textbox",
"required": true,
"readonly": false,
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}