Agreement Events¶
Common payload elements¶
Minimum payload for agreements¶
The following returns for an agreement event if all the conditional parameters are set to false while creating webhooks:
Parameter Name |
Type |
Description |
Possible enums |
|
String |
The unique identifier of agreement that can be used to query status and download signed documents. |
|
|
String |
The name of the agreement that will be used to identify it in emails and on the website. |
|
|
Enum |
The current status of the agreement. |
OUT_FOR_SIGNATURE, SIGNED, APPROVED, ACCEPTED, DELIVERED, FORM_FILLED, ABORTED, EXPIRED, OUT_FOR_APPROVAL, OUT_FOR_ACCEPTANCE, OUT_FOR_DELIVERY, OUT_FOR_FORM_FILLING, or CANCELLED |
Payload attributes inherited from Agreement¶
Parameter Name |
Type |
Description |
Possible Enums |
|---|---|---|---|
|
String |
The unique identifier of the agreement, which can be used to query the status and download signed documents. |
|
|
String |
The name of the agreement that will be used to identify it, in emails and on the website. |
|
|
Enum |
Specifies the type of signature requested on the agreement—written or e-signature. |
ESIGN, WRITTEN |
|
Enum |
The current status of the agreement. |
OUT_FOR_SIGNATURE, OUT_FOR_DELIVERY, OUT_FOR_ACCEPTANCE, OUT_FOR_FORM_FILLING, OUT_FOR_APPROVAL, AUTHORING, CANCELLED, SIGNED, APPROVED, DELIVERED, ACCEPTED, FORM_FILLED, EXPIRED, ARCHIVED, PREFILL, WIDGET_WAITING_FOR_VERIFICATION, DRAFT, DOCUMENTS_NOT_YET_PROCESSED, WAITING_FOR_FAXING, WAITING_FOR_VERIFICATION |
|
Array of Strings |
Email IDs of cc: participants of the agreement. |
|
|
Object |
Device info of the offline device. It will only be returned in the case of offline agreement creation. |
|
|
Boolean |
Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation. |
|
|
Date |
Agreement creation date. |
|
|
Timestamp |
The date after which the agreement can no longer be signed, if an expiration date is configured. The value is nil if an expiration date is not set for the document. |
|
|
Object |
A unique identifier provided by an external system search for your transaction through the API. |
|
|
Object |
Determines the URL and associated properties for the success page the user will be taken to after completing the signing process. Will never be returned in offline agreement creation. |
|
|
Integer |
Integer which specifies the delay in hours before sending the first reminder. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference between the agreement creation time and the expiration time of the agreement in hours. If this is not specified while creating the agreement, but the reminder frequency is specified, then the first reminder will be sent based on frequency: in other words, if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Will never be returned in offline agreement creation. |
|
|
String |
The locale associated with this agreement. Specifies the language for the signing page and emails: for example, en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender. |
|
|
String |
The message associated with the agreement that the sender has provided. |
|
|
Enum |
Specifies how often reminders will be sent to the recipients. |
DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED |
|
String |
Email of the sender. |
|
|
Object |
Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider. |
|
|
String |
Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation. |
|
|
Object |
Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold. |
|
|
Object |
Returns the IDs of the documents of an agreement. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold. In some cases when document processing takes a lot of time, you might not get documentsInfo even if the conditional parameter includeDocumentsInfo was set to true. In such a case try calling the v6 GET /agreements/{agreementId}/documents API to get the details of the documents of an agreement. |
|
|
Object |
Returns the supporting documents of an agreement. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold. In some cases when document processing takes a lot of time, you might not get documentsInfo even if the conditional parameter includeDocumentsInfo was set to true, In such a case try calling the v6 GET /agreements/{agreementId}/documents API to get the details of the supporting documents of an agreement. |
|
|
Array of Strings |
If event notification payload size exceeds the defined threshold, the conditional parameters will not be sent in the notification request, even if they are set to true by the webhook creator. The conditionalParametersTrimmed attribute will be set to the keys trimmed in this case. If no conditional parameters are specified by the webhook creator, or if they are specified, but no key is trimmed, this parameter will not be returned. |
AGREEMENT_ALL¶
Web app name: Agreement all events
To subscribe to all agreement events, subscribe to AGREEMENT_ALL.
Tip
AGREEMENT_ALL retrieves all agreement events, including events added in the future.
AGREEMENT_CREATED¶
Web app name: Agreement created
Triggers when an agreement or draft is created.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sharee of the originator of the agreement who sent the agreement on behalf of the sender in the case of account sharing. |
|
String |
The user email of the sharee of the originator of the agreement who sent the agreement on behalf of the sender in the case of account sharing. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_RESTARTED¶
Web app name: Agreement restarted.
Triggers when an agreement is restarted.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_MODIFIED¶
Web app name: Agreement modified
Triggers when an agreement in an “in-process” un-signed agreement has been replaced or changed.
Status change on event: The value of status in the event notification payload is unchanged.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sharee of the originator of the agreement who modified the agreement on behalf of the sender in the case of account sharing. |
|
String |
The user email of the sharee of the originator of the agreement who modified the agreement on behalf of the sender in the case of account sharing. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_PARTICIPANT_COMPLETED¶
Web app name: Agreement participant completed
Triggers when a participant completes their action.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_PARTICIPANT_REPLACED¶
Web app name: Agreement participant replaced
Triggers when an agreement’s participant is replaced.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_ACTION_REPLACED_SIGNER¶
Web app name: Agreement participant replaced
Triggers when an agreement signer changes.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the replaced signer. |
|
String |
The user email of the replaced signer. |
|
String |
The ID of the originator of the agreement. |
|
String |
The email of the originator of the agreement. |
|
String |
The user ID of the sharee of the originator of the agreement who replaced a signer on behalf of the sender in the case of account sharing. |
|
String |
The user email of the sharee of the originator of the agreement who replaced a signer on behalf of the sender in the case of account sharing. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_ACTION_DELEGATED¶
Web app name: Agreement delegated
Triggers when an agreement is delegated by a participant.
Parameter Name |
Type |
Description |
Possible enums |
|---|---|---|---|
|
String |
Subevent. |
DELEGATED, AUTO_DELEGATED |
|
String |
The user ID of the delegatee. |
|
|
String |
The user email of the delegatee. |
|
|
String |
The user ID of the delegator. |
|
|
String |
The user email of the delegator. |
|
|
String |
Never part of the payload. |
|
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantRole": "",
"actionType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_ACTION_REQUESTED¶
Web app name: Agreement sent
Triggers when an agreement is sent to a participant.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the user to whom the action is requested. User could be the signer or the delegatee. |
|
String |
The user email of the user to whom the action is requested. User could be the signer or the delegatee. |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantRole": "",
"actionType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_ACTION_COMPLETED¶
Web app name: Agreement participant completed
Triggers when a participant completes their action.
Parameter Name |
Type |
Description |
Possible Enums |
|---|---|---|---|
|
String |
Action type for the event. |
ESIGNED, DIGSIGNED, WRITTEN_SIGNED, PRESIGNED, ACCEPTED, SIGNED, APPROVED, DELIVERED, FORM_FILLED, ACKNOWLEDGED, DIGITAL_SIGN_UIDAI_SIGNER_CONSENT |
|
String |
The user ID of the action taker. This can be the signer or the delegatee. |
|
|
String |
The user email of the action taker. This can be the signer or the delegatee. |
|
|
String |
The user ID of the action taker. This can be the signer or the delegatee. |
|
|
String |
The user email of the action taker. This can be the signer or the delegatee. |
|
|
String |
Never part of the payload. |
|
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantRole": "",
"actionType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM¶
Web app name: Agreement creation failed
Triggers when an agreement is auto-canceled due to a conversion problem.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
Never part of the payload. |
|
String |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
}
}
}
AGREEMENT_DOCUMENTS_DELETED¶
Web app name: Agreement deleted
Triggers when agreement documents are deleted.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
String |
The user ID of the sharee of the originator of the agreement who deleted the documents on behalf of the sender in the case of account sharing. |
|
String |
The user email of the sharee of the originator of the agreement who deleted the documents on behalf of the sender in the case of account sharing. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
}
}
}
AGREEMENT_EMAIL_BOUNCED¶
Web app name: Agreement email bounced
Triggers when an agreement email gets bounced.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the user for which the email bounced. This can be the signer or the delegatee. |
|
String |
The user email of the user for which the email bounced. This can be the signer or the delegatee. |
|
String |
The user ID of the user for which the email bounced. This can be the signer or the delegatee. |
|
String |
The user email of the user for which the email bounced. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_EMAIL_VIEWED¶
Web app name: Agreement email viewed
Triggers when an agreement email is viewed by a recipient.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the user who viewed the email. This can be the signer or the delegatee. |
|
String |
The user email of the user who viewed the email. This can be the signer or the delegatee. |
|
String |
The user ID of the user who viewed the email. This can be the signer or the delegatee. |
|
String |
|
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_EMAIL_OTP_AUTHENTICATED¶
Web app name: Agreement participant Email OTP authenticated
Triggers when an agreement participant is authenticated via email OTP.
AGREEMENT_RECALLED_MAX_SIGNING_EMAIL_OTP_ATTEMPTS¶
Web app name: Agreement RECALLED Maximum signing Email OTP attempts
Triggers when the maximum number of Email OTP authentication attempts exceeds.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"email": "",
"id": "",
"payloadApplicable": "",
"role": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"emailOption": {
"sendTarget": {
"completionEmails": "",
"inFlightEmails": "",
"initEmails": ""
}
},
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_REMINDER_INITIATED¶
Web app name: Agreement reminder initiated
Triggers when an agreement reminder is initiated.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantRole": "",
"actionType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
},
"reminderInfo": {
"id": "",
"note": "",
"participantList": [
{
"participantUserId": "",
"id": "",
"email": ""
}
]
}
}
AGREEMENT_REMINDER_SENT¶
Web app name: Agreement reminder sent
Triggers when an agreement reminder is sent.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantRole": "",
"actionType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
},
"reminderInfo": {
"id": "",
"note": "",
"participantList": [
{
"participantUserId": "",
"id": "",
"email": ""
}
]
}
}
AGREEMENT_OFFLINE_SYNC¶
Web app name: Agreement synced post offline event
Triggers when an offline agreement syncs.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the user for whom the signing URL is fetched. This can be the signer or the delegatee. |
|
String |
The user email of the user for whom the signing URL is fetched. This can be the signer or the delegatee. |
|
String |
The user ID of the user for whom the signing URL is fetched. This can be the signer or the delegatee. |
|
String |
The user email of the user for whom the signing URL is fetched. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_WEB_IDENTITY_AUTHENTICATED¶
Web app name: Agreement participant social identity authenticated
Deprecated. Do not subscribe to this event.
Triggers when an agreement participant is authenticated through web or social identity, such as Google, Facebook, and so on.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the authenticated user. This can be the signer or the delegatee. |
|
String |
The user email of the authenticated user. This can be the signer or the delegatee. |
|
String |
The user ID of the authenticated user. This can be the signer or the delegatee. |
|
String |
The user email of the authenticated user. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_KBA_AUTHENTICATED¶
Web app name: Agreement participant KBA authenticated
Triggers when an agreement participant is authenticated through knowledge-based authentication.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the authenticated user. This can be the signer or the delegatee. |
|
String |
The user email of the authenticated user. This can be the signer or the delegatee. |
|
String |
The user ID of the authenticated user. This can be the signer or the delegatee. |
|
String |
The user email of the authenticated user. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_READY_TO_NOTARIZE¶
Web app name: Not available in the UI
Triggers when an agreement is ready to notarize.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"accountId": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_USER_ACK_AGREEMENT_MODIFIED¶
Web app name: Agreement modification acknowledged
Triggers when a signer acknowledges modification before signing.
Status change on event: The value of status in the event notification payload is unchanged.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the user who acknowledged the agreement modifications. This can be the signer or the delegatee. |
|
String |
The user email of the user who acknowledged the agreement modifications. This can be the signer or the delegatee. |
|
String |
The user ID of the user who acknowledged the agreement modifications. This can be the signer or the delegatee. |
|
String |
The user email of the user who acknowledged the agreement modifications. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_READY_TO_VAULT¶
Web app name: Not available in the UI
Triggers when an agreement is ready to vault.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_VAULTED¶
Web app name: Agreement vaulted
Triggers when an agreement is vaulted.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the most recent signing user. This can be the signer or the delegatee. |
|
String |
The user email of the most recent signing user. This can be the signer or the delegatee. |
|
String |
The user ID of the most recent signing user. This can be the signer or the delegatee. |
|
String |
The user email of the most recent signing user. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER¶
Web app name: Agreement signer name changed by signer
Triggers when a recipient changes their name value during the e-signing process from the name value provided when the agreement was created.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"email": "",
"id": "",
"payloadApplicable": "",
"role": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"emailOption": {
"sendTarget": {
"completionEmails": "",
"inFlightEmails": "",
"initEmails": ""
}
},
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_WORKFLOW_COMPLETED¶
Web app name: Agreement workflow completed
Triggers when an agreement workflow is completed successfully, and all participants have taken their respective action.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the last action taker. This can be the signer or the delegatee. |
|
String |
The user email of the last action taker. This can be the signer or the delegatee. |
|
String |
The user ID of the last action taker. This can be the signer or the delegatee. |
|
String |
The user email of the last action taker. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantRole": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
},
"signedDocumentInfo": {
"document": ""
}
}
}
AGREEMENT_DELETED¶
Web app name: Agreement deleted
Triggers when agreement documents are deleted.
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_RECALLED¶
Updated: July, 2023
Web app name: Agreement cancelled
Triggers when an agreement is canceled/recalled
Parameter Name |
Type |
Description |
Possible Enums |
|---|---|---|---|
|
String |
Subevent. |
RECALLED, MAX_SIGNING_KBA_ATTEMPTS_EXCEEDED, MAX_SIGNING_PASSWORD_ATTEMPTS_EXCEEDED, MAX_SIGNING_PHONE_ATTEMPTS_EXCEEDED |
|
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
|
String |
The user ID email of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
`` actingUserId`` |
String |
The user ID of the sender or originator of the agreement. When this agreement is created by signing a widget, then this will be details of the creator of the widget. |
|
|
String |
The user email of the sharee of the originator of the agreement who recalled the agreement on behalf of the sender in the case of account sharing. |
|
|
String |
The user ID of the sharee of the originator of the agreement who recalled the agreement on behalf of the sender in the case of account sharing. |
|
|
String |
The user email of the sharee of the originator of the agreement who recalled the agreement on behalf of the sender in the case of account sharing. |
|
|
String |
Any arbitrary comment. |
|
|
Boolean |
True or false (default) depending on whether recipients should be notified that the transaction(s) have been cancelled. This field is set when an agreement is cancelled using the |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
},
"agreementCancellationInfo": {
"comment": "",
"notifyOthers": ""
}
}
AGREEMENT_REJECTED¶
Web app name: Agreement rejected
Triggers when an agreement is rejected by a participant.
Parameter Name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the action taker. This can be the signer or the delegatee. |
|
String |
The user email of the action taker. This can be the signer or the delegatee. |
|
String |
The user ID of the action taker. This can be the signer or the delegatee. |
|
String |
The user email of the action taker. This can be the signer or the delegatee. |
|
String |
Never part of the payload. |
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_EXPIRED¶
Web app name: Agreement expired
Triggers when an agreement expires.
Parameter Name |
Type |
Description |
Possible Enums |
|---|---|---|---|
|
String |
Subevent. |
EXPIRED, EXPIRED_AUTOMATICALLY |
|
String |
The user ID of the user for which agreement expired. This can be the signer or the delegatee. |
|
|
String |
The user email of the user for which agreement expired. This can be the signer or the delegatee. |
|
|
String |
The user ID of the user for which agreement expired. This can be the signer or the delegatee. |
|
|
String |
The user email of the user for which agreement expired. This can be the signer or the delegatee. |
|
|
String |
Never part of the payload. |
|
|
String |
Never part of the payload. |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"actingUserIpAddress": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_EXPIRATION_UPDATED¶
Web app name: Not available in the UI
Triggers when an agreement’s expiration date is updated.
TBD
{
"originatorAccountId": "",
"actingUserEmail": "",
"actingUserId": "",
"actingUserIpAddress": "",
"agreement": {
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"createdDate": "",
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"deviceTime": "",
"location": {
"latitude": "",
"longitude": ""
}
},
"documentVisibilityEnabled": "",
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"mimeType": "",
"name": "",
"numPages": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
},
"expirationTime": "",
"externalId": {
"id": ""
},
"firstReminderDelay": "",
"id": "",
"locale": "",
"message": "",
"name": "",
"participantSetsInfo": {
"participantSets": [
{
"id": "",
"memberInfos": [
{
"company": "",
"email": "",
"id": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"name": "",
"order": "",
"privateMessage": "",
"role": "",
"status": ""
}
]
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"reminderFrequency": "",
"senderEmail": "",
"signatureType": "",
"status": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": ""
},
"event": "",
"eventDate": "",
"eventResourceParentId": "",
"eventResourceParentType": "",
"eventResourceType": "",
"initiatingUserEmail": "",
"initiatingUserId": "",
"participantUserEmail": "",
"participantUserId": "",
"subEvent": "",
"webhookId": "",
"webhookName": "",
"webhookNotificationApplicableUsers": [
{
"email": "",
"id": "",
"payloadApplicable": "",
"role": ""
}
],
"webhookNotificationId": "",
"webhookScope": "",
"webhookUrlInfo": {
"url": ""
}
}
AGREEMENT_DOCUMENTS_VIEWED¶
Implemented: July, 2023
Web app name: Not available in the UI
Triggers when a user views an agreement
TBD
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"email": "",
"id": "",
"payloadApplicable": "",
"role": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserIpAddress": "",
"actingUserEmail": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED¶
Implemented: July, 2023
Web app name: Not available in the UI
Triggers when a user views an agreement that is password protected
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"email": "",
"id": "",
"payloadApplicable": "",
"role": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"eventResourceParentType": "",
"eventResourceParentId": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserIpAddress": "",
"actingUserEmail": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"agreement": {
"id": "",
"name": "",
"signatureType": "",
"status": "",
"ccs": [
{
"email": "",
"label": "",
"visiblePages": [
""
]
}
],
"deviceInfo": {
"applicationDescription": "",
"deviceDescription": "",
"location": {
"latitude": "",
"longitude": ""
},
"deviceTime": ""
},
"documentVisibilityEnabled": "",
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"reminderFrequency": "",
"senderEmail": "",
"vaultingInfo": {
"enabled": ""
},
"workflowId": "",
"participantSetsInfo": {
"participantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
],
"nextParticipantSets": [
{
"memberInfos": [
{
"id": "",
"email": "",
"company": "",
"name": "",
"privateMessage": "",
"status": ""
}
],
"order": "",
"role": "",
"status": "",
"id": "",
"name": "",
"privateMessage": ""
}
]
},
"documentsInfo": {
"documents": [
{
"id": "",
"label": "",
"numPages": "",
"mimeType": "",
"name": ""
}
],
"supportingDocuments": [
{
"displayLabel": "",
"fieldName": "",
"id": "",
"mimeType": "",
"numPages": ""
}
]
}
}
}
TBD