update docs
This commit is contained in:
Alex Turchyn
committed by
Pete Matsyburka
Pete Matsyburka
parent
25c5c11ab3
commit
93e0730210
@@ -1,6 +1,6 @@
|
||||
# Form Webhook
|
||||
|
||||
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."
|
||||
},
|
||||
"decline_reason": {
|
||||
"type": "string",
|
||||
"description": "Submitter provided decline message."
|
||||
},
|
||||
"sent_at": {
|
||||
"type": "string",
|
||||
"description": "The date and time when the signing request was sent to the submitter.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"status": {
|
||||
@@ -98,22 +102,27 @@ During the form filling and signing process, 3 types of events may occur and are
|
||||
},
|
||||
"opened_at": {
|
||||
"type": "string",
|
||||
"description": "The date and time when the submitter opened the signing form.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"completed_at": {
|
||||
"type": "string",
|
||||
"description": "The date and time when the submitter completed the signing form.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"declined_at": {
|
||||
"type": "string",
|
||||
"description": "The date and time when the submitter declined the signing form.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
"description": "The date and time when the submitter was created.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"updated_at": {
|
||||
"type": "string",
|
||||
"description": "The date and time when the submitter was last updated.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"submission": {
|
||||
@@ -189,6 +198,7 @@ During the form filling and signing process, 3 types of events may occur and are
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"description": "Submitter preferences for notifications.",
|
||||
"properties": {
|
||||
"send_email": {
|
||||
"type": "boolean",
|
||||
@@ -210,7 +220,7 @@ During the form filling and signing process, 3 types of events may occur and are
|
||||
"type": "string",
|
||||
"description": "The field name."
|
||||
},
|
||||
"values": {
|
||||
"value": {
|
||||
"type": "string",
|
||||
"description": "The field value."
|
||||
}
|
||||
@@ -231,6 +241,7 @@ During the form filling and signing process, 3 types of events may occur and are
|
||||
},
|
||||
"documents": {
|
||||
"type": "array",
|
||||
"description": "List of completed documents signed by the submitter.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@@ -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
|
||||
},
|
||||
"submission_events": {
|
||||
"type": "array",
|
||||
"description": "List of submission events.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@@ -3,7 +3,8 @@
|
||||
Get template creation and update notifications using these events:
|
||||
|
||||
- **'template.created'** is triggered when the template is created.
|
||||
- **'tempate.updated'** is triggered when the template is updated.
|
||||
- **'template.updated'** is triggered when the template is updated.
|
||||
- **'template.archived'** is triggered when the template is archived.
|
||||
|
||||
|
||||
|
||||
@@ -14,13 +15,16 @@ Get template creation and update notifications using these events:
|
||||
"description": "The event type.",
|
||||
"enum": [
|
||||
"template.created",
|
||||
"template.updated"
|
||||
"template.updated",
|
||||
"template.archived"
|
||||
]
|
||||
},
|
||||
"timestamp": {
|
||||
"type": "string",
|
||||
"description": "The event timestamp.",
|
||||
"example": "2023-09-24T11:20:42Z",
|
||||
"examples": [
|
||||
"2023-09-24T11:20:42Z"
|
||||
],
|
||||
"format": "date-time"
|
||||
},
|
||||
"data": {
|
||||
@@ -74,6 +78,31 @@ Get template creation and update notifications using these events:
|
||||
"type": "string",
|
||||
"description": "The field name."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "The field type.",
|
||||
"enum": [
|
||||
"heading",
|
||||
"text",
|
||||
"signature",
|
||||
"initials",
|
||||
"date",
|
||||
"number",
|
||||
"image",
|
||||
"checkbox",
|
||||
"multiple",
|
||||
"file",
|
||||
"radio",
|
||||
"select",
|
||||
"cells",
|
||||
"stamp",
|
||||
"payment",
|
||||
"phone",
|
||||
"verification",
|
||||
"kba",
|
||||
"strikethrough"
|
||||
]
|
||||
},
|
||||
"required": {
|
||||
"type": "boolean",
|
||||
"description": "The flag indicating whether the field is required."
|
||||
@@ -120,6 +149,7 @@ Get template creation and update notifications using these events:
|
||||
},
|
||||
"submitters": {
|
||||
"type": "array",
|
||||
"description": "List of submitter roles defined in the template.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -138,12 +168,11 @@ Get template creation and update notifications using these events:
|
||||
"type": "integer",
|
||||
"description": "Unique identifier of the author of the template."
|
||||
},
|
||||
"account_id": {
|
||||
"type": "integer",
|
||||
"description": "Unique identifier of the account of the template."
|
||||
},
|
||||
"archived_at": {
|
||||
"type": "string",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "Date and time when the template was archived."
|
||||
},
|
||||
"created_at": {
|
||||
@@ -164,7 +193,10 @@ Get template creation and update notifications using these events:
|
||||
]
|
||||
},
|
||||
"external_id": {
|
||||
"type": "string",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "Identifier of the template in the external system."
|
||||
},
|
||||
"folder_id": {
|
||||
@@ -175,12 +207,17 @@ Get template creation and update notifications using these events:
|
||||
"type": "string",
|
||||
"description": "Folder name where the template is placed."
|
||||
},
|
||||
"application_key": {
|
||||
"type": "string",
|
||||
"description": "Your application-specific unique string key to identify tempate_id within your app."
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"description": "Template preferences object."
|
||||
},
|
||||
"shared_link": {
|
||||
"type": "boolean",
|
||||
"description": "Flag indicating whether the shared link is enabled for the template."
|
||||
},
|
||||
"author": {
|
||||
"type": "object",
|
||||
"description": "Author of the template.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
|
||||
Reference in New Issue
Block a user