"description": "A list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.",
"description": "Set `false` to now show the documents list on the left. Documents list is displayed by default."
"description": "Set `false` to not show the documents list on the left. Documents list is displayed by default."
},
"withDynamicDocuments": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to allow converting DOCX files to editable dynamic documents."
},
"withFieldsList": {
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to now show the fields list on the right. Fields list is displayed by default."
"description": "Set `false` to not show the fields list on the right. Fields list is displayed by default."
},
"withFieldsDetection": {
"type": "boolean",
@ -453,6 +468,12 @@ const token = jwt.sign({
"default": false,
"description": "Display a button to automatically detect and add fields to the document with AI."
},
"withCustomFieldsTab": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `fields` or `requiredFields` prop."
},
"withFieldPlaceholder": {
"type": "boolean",
"required": false,
@ -464,6 +485,12 @@ const token = jwt.sign({
"required": false,
"description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default."
},
"withRevisions": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history."
"description": "Comma separated list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.",
"example": "MM/DD/YYYY,YYYY-MM-DD HH:mm:ss z"
},
"data-draw-field-type": {
"type": "string",
"required": false,
@ -403,13 +412,19 @@
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to now show the documents list on the left. Documents list is displayed by default."
"description": "Set `false` to not show the documents list on the left. Documents list is displayed by default."
},
"data-with-dynamic-documents": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to allow converting DOCX files to editable dynamic documents."
},
"data-with-fields-list": {
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to now show the fields list on the right. Fields list is displayed by default."
"description": "Set `false` to not show the fields list on the right. Fields list is displayed by default."
},
"data-with-fields-detection": {
"type": "boolean",
@ -417,6 +432,12 @@
"default": false,
"description": "Display a button to automatically detect and add fields to the document with AI."
},
"data-with-custom-fields-tab": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `data-fields` or `data-required-fields` attribute."
},
"data-with-field-placeholder": {
"type": "boolean",
"required": false,
@ -428,6 +449,12 @@
"required": false,
"description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default."
},
"data-with-revisions": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history."
"description": "A list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.",
"description": "Set `false` to now show the documents list on the left. Documents list is displayed by default."
"description": "Set `false` to not show the documents list on the left. Documents list is displayed by default."
},
"withDynamicDocuments": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to allow converting DOCX files to editable dynamic documents."
},
"withFieldsList": {
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to now show the fields list on the right. Fields list is displayed by default."
"description": "Set `false` to not show the fields list on the right. Fields list is displayed by default."
},
"withFieldsDetection": {
"type": "boolean",
@ -444,6 +459,12 @@ const token = jwt.sign({
"default": false,
"description": "Display a button to automatically detect and add fields to the document with AI."
},
"withCustomFieldsTab": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `fields` or `requiredFields` prop."
},
"withFieldPlaceholder": {
"type": "boolean",
"required": false,
@ -455,6 +476,12 @@ const token = jwt.sign({
"required": false,
"description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default."
},
"withRevisions": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history."
"description": "A list of formats to be used for the date field. Formats may include date ('YYYY', 'MM', 'DD'), time ('HH', 'hh', 'mm', 'ss', 'A') and timezone ('z') parts. The first format in the list is used as the default.",
"description": "Set `false` to now show the documents list on the left. Documents list is displayed by default."
"description": "Set `false` to not show the documents list on the left. Documents list is displayed by default."
},
"with-dynamic-documents": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to allow converting DOCX files to editable dynamic documents."
},
"with-fields-list": {
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to now show the fields list on the right. Fields list is displayed by default."
"description": "Set `false` to not show the fields list on the right. Fields list is displayed by default."
},
"with-fields-detection": {
"type": "boolean",
@ -459,6 +474,12 @@ const token = jwt.sign({
"default": false,
"description": "Display a button to automatically detect and add fields to the document with AI."
},
"with-custom-fields-tab": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to display a separate \"Custom\" fields tab in the fields list. Custom fields can be configured using the `:fields` or `:required-fields` prop."
},
"with-field-placeholder": {
"type": "boolean",
"required": false,
@ -470,6 +491,12 @@ const token = jwt.sign({
"required": false,
"description": "Set to `true` to enable Signature ID by default for newly added fields. If set to `false`, the Signature ID toggle will be displayed under field settings, with the Signature ID turned off by default."
},
"with-revisions": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set `true` to save revisions and display a dropdown next to the Save button that provides access to the template revisions history."
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend.</b>.",
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend</b>.",
"required": false,
"properties": {
"slug": {
@ -109,7 +109,7 @@ export class AppComponent {}
"language": {
"type": "string",
"required": false,
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically."
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically."
},
"i18n": {
"type": "object",
@ -127,7 +127,7 @@ export class AppComponent {}
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
"description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
},
"withFieldPlaceholder": {
"type": "boolean",
@ -232,6 +232,12 @@ export class AppComponent {}
"default": false,
"description": "Set `true` to display the complete button in the form header."
},
"onlyRequiredFields": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields."
},
"allowToResubmit": {
"type": "boolean",
"required": false,
@ -241,7 +247,7 @@ export class AppComponent {}
"signature": {
"type": "string",
"required": false,
"description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
"description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
},
"rememberSignature": {
"type": "boolean",
@ -311,7 +317,7 @@ export class AppComponent {}
"onComplete": {
"type": "event emitter",
"required": false,
"description": "Event emitted the form completion.",
"description": "Event emitted on form completion.",
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend.</b>.",
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend</b>.",
"required": false,
"properties": {
"slug": {
@ -105,7 +105,7 @@
"data-language": {
"type": "string",
"required": false,
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically."
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically."
},
"data-i18n": {
"type": "string",
@ -153,7 +153,7 @@
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
"description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
},
"data-with-field-placeholder": {
"type": "boolean",
@ -179,6 +179,12 @@
"default": false,
"description": "Set `true` to display the complete button in the form header."
},
"data-only-required-fields": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields."
},
"data-allow-to-resubmit": {
"type": "boolean",
"required": false,
@ -194,7 +200,7 @@
"data-signature": {
"type": "string",
"required": false,
"description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
"description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend.</b>.",
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend</b>.",
"required": false,
"properties": {
"slug": {
@ -106,7 +106,7 @@ export function App() {
"language": {
"type": "string",
"required": false,
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically."
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically."
},
"i18n": {
"type": "object",
@ -124,7 +124,7 @@ export function App() {
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
"description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
},
"withFieldPlaceholder": {
"type": "boolean",
@ -229,6 +229,12 @@ export function App() {
"default": false,
"description": "Set `true` to display the complete button in the form header."
},
"onlyRequiredFields": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields."
},
"allowToResubmit": {
"type": "boolean",
"required": false,
@ -244,7 +250,7 @@ export function App() {
"signature": {
"type": "string",
"required": false,
"description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
"description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend.</b>.",
"description": "JSON Web Token (JWT HS256) with a payload signed using the API key. <b>JWT can be generated only on the backend</b>.",
"required": false,
"properties": {
"slug": {
@ -115,7 +115,7 @@ export default {
"language": {
"type": "string",
"required": false,
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. Be default the form is displayed in the user browser language automatically."
"description": "UI language: en, es, it, de, fr, nl, pl, uk, cs, pt, he, ar, kr, ja languages are available. By default the form is displayed in the user browser language automatically."
},
"i18n": {
"type": "object",
@ -145,7 +145,7 @@ export default {
"type": "boolean",
"required": false,
"default": true,
"description": "Set `false` to hide field name. Hidding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
"description": "Set `false` to hide field name. Hiding field names can be useful for when they are not in the human readable format. Field names are displayed by default."
},
"with-field-placeholder": {
"type": "boolean",
@ -195,6 +195,12 @@ export default {
"default": false,
"description": "Set `true` to display the complete button in the form header."
},
"only-required-fields": {
"type": "boolean",
"required": false,
"default": false,
"description": "Set to `true` to display only required fields in the step-by-step form, hiding all optional fields."
},
"allow-to-resubmit": {
"type": "boolean",
"required": false,
@ -204,7 +210,7 @@ export default {
"signature": {
"type": "string",
"required": false,
"description": "Allows pre-filling signature fields. The value can be a base64 encoded image string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
"description": "Allows pre-filling signature fields. The value can be a base64 encoded data:image/ string, a public URL to an image, or plain text that will be rendered as a typed signature using a standard font."
During the form filling and signing process, 3 types of events may occur and are dispatched at different stages:
During the form filling and signing process, 4 types of events may occur and are dispatched at different stages:
- **'form.viewed'** event is triggered when the submitter first opens the form.
- **'form.started'** event is triggered when the submitter initiates filling out the form.
@ -19,13 +19,16 @@ During the form filling and signing process, 3 types of events may occur and are
"enum": [
"form.viewed",
"form.started",
"form.completed"
"form.completed",
"form.declined"
]
},
"timestamp": {
"type": "string",
"description": "The event timestamp.",
"example": "2023-09-24T11:20:42Z",
"examples": [
"2023-09-24T11:20:42Z"
],
"format": "date-time"
},
"data": {
@ -36,20 +39,20 @@ During the form filling and signing process, 3 types of events may occur and are
"type": "number",
"description": "The submitter's unique identifier."
},
"submission_id": {
"type": "number",
"description": "The unique submission identifier."
},
"email": {
"type": "string",
"description": "The submitter's email address",
"format": "email",
"example": "john.doe@example.com"
"examples": [
"john.doe@example.com"
]
},
"ua": {
"type": "string",
"description": "The user agent string that provides information about the submitter's web browser.",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"
"examples": [
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"
]
},
"ip": {
"type": "string",
@ -62,27 +65,28 @@ During the form filling and signing process, 3 types of events may occur and are
"phone": {
"type": "string",
"description": "The submitter's phone number, formatted according to the E.164 standard.",
"example": "+1234567890"
"examples": [
"+1234567890"
]
},
"role": {
"type": "string",
"description": "The submitter's role name or title.",
"example": "First Party"
"examples": [
"First Party"
]
},
"external_id": {
"type": "string",
"description": "Your application-specific unique string key to identify submitter within your app."
},
"application_key": {
"type": "string",
"description": "Your application-specific unique string key to identify submitter within your app. Backward compatibility with the previous version of the API. Use external_id instead."
@ -16,13 +16,17 @@ Get submission creation, completion, expiration, and archiving notifications usi
"description": "The event type.",
"enum": [
"submission.created",
"submission.completed",
"submission.expired",
"submission.archived"
]
},
"timestamp": {
"type": "string",
"description": "The event timestamp.",
"example": "2023-09-24T11:20:42Z",
"examples": [
"2023-09-24T11:20:42Z"
],
"format": "date-time"
},
"data": {
@ -33,8 +37,26 @@ Get submission creation, completion, expiration, and archiving notifications usi
"type": "number",
"description": "The submission's unique identifier."
},
"archived_at": {
"name": {
"type": "string",
"description": "Name of the document submission."
},
"slug": {
"type": "string",
"description": "Unique slug of the submission."
},
"expire_at": {
"type": [
"string",
"null"
],
"description": "The date and time when the submission will expire."
},
"archived_at": {
"type": [
"string",
"null"
],
"description": "The submission archive date."
},
"created_at": {
@ -65,9 +87,19 @@ Get submission creation, completion, expiration, and archiving notifications usi
]
},
"audit_log_url": {
"type": "string",
"type": [
"string",
"null"
],
"description": "Audit log file URL."
},
"combined_document_url": {
"type": [
"string",
"null"
],
"description": "Combined PDF file URL with documents and Audit Log."
},
"submitters": {
"type": "array",
"description": "The list of submitters for the submission.",
@ -90,26 +122,40 @@ Get submission creation, completion, expiration, and archiving notifications usi
"type": "string",
"description": "The email address of the submitter.",
"format": "email",
"example": "john.doe@example.com"
"examples": [
"john.doe@example.com"
]
},
"slug": {
"type": "string",
"description": "The unique slug of the document template."
},
"sent_at": {
"type": "string",
"type": [
"string",
"null"
],
"description": "The date and time when the signing request was sent to the submitter."
},
"opened_at": {
"type": "string",
"type": [
"string",
"null"
],
"description": "The date and time when the submitter opened the signing form."
},
"completed_at": {
"type": "string",
"type": [
"string",
"null"
],
"description": "The date and time when the submitter completed the signing form."
},
"declined_at": {
"type": "string",
"type": [
"string",
"null"
],
"description": "The date and time when the submitter declined the signing form."
},
"created_at": {
@ -121,27 +167,42 @@ Get submission creation, completion, expiration, and archiving notifications usi
"description": "The date and time when the submitter was last updated."
},
"name": {
"type": "string",
"type": [
"string",
"null"
],
"description": "The name of the submitter."
},
"phone": {
"type": "string",
"type": [
"string",
"null"
],
"description": "The phone number of the submitter, formatted according to the E.164 standard.",
"example": "+1234567890"
"examples": [
"+1234567890"
]
},
"role": {
"type": "string",
"description": "The role name or title of the submitter.",
"example": "First Party"
"examples": [
"First Party"
]
},
"external_id": {
"type": "string",
"type": [
"string",
"null"
],
"description": "Your application-specific unique string key to identify this submitter within your app."
},
"metadata": {
"type": "object",
"description": "Metadata object with additional submitter information.",
"example": "{ 'customField': 'value' }"
"examples": [
"{ 'customField': 'value' }"
]
},
"status": {
"type": "string",
@ -154,10 +215,6 @@ Get submission creation, completion, expiration, and archiving notifications usi
"awaiting"
]
},
"application_key": {
"type": "string",
"description": "Your application-specific unique string key to identify this submitter within your app."
},
"values": {
"type": "object",
"description": "An object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see `fields` param."
@ -222,6 +279,7 @@ Get submission creation, completion, expiration, and archiving notifications usi
},
"created_by_user": {
"type": "object",
"description": "User who created the submission.",
"properties": {
"id": {
"type": "integer",
@ -243,6 +301,7 @@ Get submission creation, completion, expiration, and archiving notifications usi
Alex Turchyn
1 month ago
committed by
Pete Matsyburka