Webhook Events

Events are the reason for webhooks: webhooks are a way for your Acrobat Sign integration to listen for and respond to Acrobat Sign events. This page provides the info you need to determine what events your integration will listen for and respond to, and what details are included in event notifications so you can design your integration to extract the info you need from an event.

Notification payload for events

When configuring a webhook, you can choose which events for which you would like to receive payloads. Subscribing only to the specific events is useful for limiting the number of HTTPS requests to the server. You can change the list of subscribed events through the API or UI anytime. Currently webhooks can be created only for agreement, widget, and megasign events. Each event has a similar JSON schema based on the resource type, but a unique payload object that is determined by its event type. The payload will be returned in JSON format. Refer to the following events for details about the payload sent in webhook notifications:

  • AGREEMENT_ACTION_COMPLETED: When an agreement is signed by the participant.

  • AGREEMENT_ACTION_DELEGATED: When an agreement is delegated by the participant.

  • AGREEMENT_ACTION_REPLACED_SIGNER: When an agreement’s signer is replaced.

  • AGREEMENT_ACTION_REQUESTED: When an agreement action is requested.

  • AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM: When an agreement is autocancelled due to a conversion problem.

  • AGREEMENT_CREATED: When an agreement is created.

  • AGREEMENT_DOCUMENTS_DELETED: When agreement documents are deleted.

  • AGREEMENT_EMAIL_BOUNCED: When an agreement email gets bounced.

  • AGREEMENT_EMAIL_VIEWED: When agreement signing email is viewed by the signer.

  • AGREEMENT_EXPIRED: When an agreement expires.

  • AGREEMENT_KBA_AUTHENTICATED: When an agreement KBA is authenticated.

  • AGREEMENT_MODIFIED: When an agreement is modified.

  • AGREEMENT_OFFLINE_SYNC: When an agreement is synced offline.

  • AGREEMENT_RECALLED: When an agreement is cancelled.

  • AGREEMENT_REJECTED: When an agreement is rejected by the participant.

  • AGREEMENT_SHARED: When an agreement is shared.

  • AGREEMENT_UPLOADED_BY_SENDER: When an agreement is uploaded by the sender.

  • AGREEMENT_USER_ACK_AGREEMENT_MODIFIED: User acknowledgement when an agreement is modified.

  • AGREEMENT_VAULTED: When an agreement is vaulted.

  • AGREEMENT_WEB_IDENTITY_AUTHENTICATED: When an agreement web identity is authenticated.

  • AGREEMENT_WORKFLOW_COMPLETED: When an agreement workflow is completed.

  • LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM: When a library document is autocancelled due to a conversion problem.

  • LIBRARY_DOCUMENT_CREATED: When a library document is created.

  • LIBRARY_DOCUMENT_MODIFIED: When a library document is modified.

  • MEGASIGN_CREATED: When a megaSign is created.

  • MEGASIGN_RECALLED: When a megaSign is recalled.

  • MEGASIGN_SHARED: When a megaSign is shared.

  • WIDGET_ENABLED: When a widget is enabled.

  • WIDGET_DISABLED: When a widget is disabled.

  • WIDGET_CREATED: When a widget is created.

  • WIDGET_MODIFIED: When a widget is modified.

  • WIDGET_SHARED: When a widget is shared.

  • WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM: When a widget is autocancelled due to a conversion problem.

Payload info

Webhook notification payloads will be delivered using the application/json content type. The payload object contains all the relevant information about what just happened, including the type of event and the data associated with that event. Acrobat Sign then sends the payload object, via an HTTP POST request, to any endpoint URLs that you have defined as webhook URLs. The payload size is restricted to 10 MB. If an event generates a larger payload, a webhook will triggered but the conditional parameters attributes, if they’re in the request, will be removed to reduce the size of the payload. Also a conditionalParametersTrimmed array object will be included in the response for this case to tell the client which conditionalParameters info is removed. The truncation will be done in the following order:

  • includeSignedDocuments

  • includeParticipantsInfo

  • includeDocumentsInfo

  • includeDetailedInfo

Signed Documents(base 64 encoded format) will be truncated first if size exceeds, followed by participant info, document info and finally detailed info will be truncated. This may happen, for example, on an agreement completion event if it includes signed document (base 64 encoded format) as well or for an agreement with multiple form fields.

Basic webhook payload for all notifications

All events will include the following common attributes in their payloads. Additional parameters returned along with basic agreement/widget/megasign info in the payload JSON object for particular keys are defined in the payload specificiations for each event; see Notification payload for events for links.

Parameter name

Type

Description

Possible values

webhookId

String

Webhook identifier of the webhook for which the notification is being sent

webhookname

String

Name of the webhook which was provided while creating a webhook

webhookNotificationId

String

The unique identifier of the webhook notification. This will be helpful in identifying duplicate notifications, if any.

webhookNotificationApplicableUsers

Object

An array of the details of the users for which this notification is delivered. For example: Say User A and User B are in a Group G1. Say User C is in Group G2. Say both these groups and all 3 users are in Account A. Assume, group level “webhook W1” is registered on Group G1 and group level “webhook W2” is registered on Group G2. Now an agreement is sent by User A and to User B. And User B delegates the signing to User C. In the above case, the sign will generate only two notifications (corresponding to W1 and W2) for the delegation event. Current field for W1 notification will be an array of details of User A and User B. Current field for W2 notification will be an array of details of User C.

webhookUrlInfo

Object

URL on which this HTTPS POST notification is triggered.

webhookScope

String

Scope of the webhook

ACCOUNT,GROUP,USER,RESOURCE

event

String

Event for which the webhook notification is triggered

AGREEMENT_CREATED

eventDate

String

Timestamp of when the event happened.

Example value: 2018-08-09T12:01:00Z

eventResourceParentType

enum

In case of agreements, it is possible that the agreement is created by signing a widget or while creating a megasign. This field informs about such cases. Only added in payloads of agreement type resources.

WIDGET,MEGASIGN

eventResourceParentId

String

Unique identifier of the widget or megasign from which this agreement is created. Only added in payloads of agreement type resources.

subEvent

String

Subevent for which the webhook notification is triggered. This field is event specific and returned with only few events, please look into individual event for the details

eventResourceType

String

The resource type on which the event is triggered.

AGREEMENT,WIDGET,MEGASIGN

participantRole

String

Role assumed by all participants in the participant set to which the participant belongs (signer, approver etc.). This is the role of the participantUser. This key will be returned only for the following events: AGREEMENT_WORKFLOW_COMPLETED, AGREEMENT_ACTION_COMPLETED, AGREEMENT_ACTION_DELEGATED, AGREEMENT_ACTION_REQUESTED

SIGNER, DELEGATE_TO_SIGNER, APPROVER, DELEGATE_TO_APPROVER, ACCEPTOR, DELEGATE_TO_ACCEPTOR, FORM_FILLER, DELEGATE_TO_FORM_FILLER, CERTIFIED_RECIPIENT, DELEGATE_TO_CERTIFIED_RECIPIENT or SHARE

actionType

String

This key will be returned only with the event AGREEMENT_ACTION_COMPLETED.

participantUserId

String

This field is Event-specific payload attributes; please look into the individual event for details

participantUserEmail

String

This field is Event-specific payload attributes; please look into the individual event for details

actingUserId

String

This field is Event-specific payload attributes; please look into the individual event for details

actingUserEmail

String

This field is Event-specific payload attributes; please look into the individual event for details


initiatingUserId

String

This field is Event-specific payload attributes; please look into the individual event for details

initiatingUserEmail

String

This field is Event-specific payload attributes; please look into the individual event for details

actingUserIpAddress

String

IP address of user that triggered the event

agreement

Agreement

Information about the agreement on which the event occurred. This key will be returned only if the event is an agreement event.

widget

Widget

Information about the widget on which the event occurred. This key will be returned only if the event is a widget event.

megasign

MegaSign

Information about the megaSign on which the event occurred. This key will be returned only if the event is a megaSign event.

WebhookNotificationApplicableUsers

Parameter name

Type

Description

Possible values

id

String

The unique identifier of the user for which the notification is applicable.

email

String

Email address of the user for which the notification is applicable.

role

enum

Role of the user in the workflow.

SIGNER, DELEGATE_TO_SIGNER, APPROVER, DELEGATE_TO_APPROVER, ACCEPTOR, DELEGATE_TO_ACCEPTOR, FORM_FILLER, DELEGATE_TO_FORM_FILLER, CERTIFIED_RECIPIENT, DELEGATE_TO_CERTIFIED_RECIPIENT, or SHARE

payloadApplicable

boolean

Indicates whether the payload attached to this notification is fetched in the context of this user or not. The boolean will be true for one and only one of the users in the webhookNotificationApplicableUsers array.

WebhookUrlInfo

Parameter name

REST object

Description

Sample value

Url

String

HTTPS URL of the webhook

https://example.com/callback?guid=test

Agreement

This is the minimal info which will be returned for an agreement event if all the conditional parameters are set to false while creating webhooks.

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of agreement that can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

status

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

Widget

This is the minimal info which will be returned for a widget event if all the conditional parameters are set to false while creating webhooks.

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of widget that can be used to retrieve the data entered by the signers

name

String

The name of the widget that will be used to identify it, in emails, website, and other places

status

Enum

The current status of the widget

DRAFT or ACTIVE or AUTHORING

Library Document

This is the minimal info which will be returned for a Library Document event if all the conditional parameters are set to false while creating webhooks.

Parameter name

Type

Description

Possible enums

id

String

The unique identifier that is used to refer to the library template.

name

String

The name of the library template that will be used to identify it, in emails and on the website.

status

Enum

The current status of the library document.

AUTHORING, ACTIVE or REMOVED

MegaSign

This is the minimal info which will be returned for a MegaSign event if all the conditional parameters are set to false while creating webhooks.

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of the agreement; it can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

status

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

payloadApplicable

boolean

Indicates whether the payload attached to this notification is fetched in the context of this user or not. The boolean will be true for one and only one of the users in the webhookNotificationApplicableUsers array.

For different MegaSign events, the detailed agreement info, participant info, document info, and the signed document will be returned based on the conditional parameters specified during webhook creation.

Receiving a webhook notification

Once your webhook URL is added, your app will start receiving “notification requests” every time a subscribed event is triggered in Sign. A notification request is an HTTPS POST request with a JSON body. The request’s POST parameters will contain JSON data relevant to the event that triggered the request. Additionally, we perform an implicit verification of intent in each webhook notification request that we send to the webhook URL. Thus, every notification request will also include a header called X-AdobeSign-ClientId that includes client id of the application that created the webhook. We will consider the webhook notification successfully delivered, if an only if success response (2 response code) is returned and the header (X-AdobeSign-ClientId) is echoed back in response HTTP header or in a JSON response body with key as xAdobeSignClientId and value as the same client id, otherwise we will retry to deliver the notification to the webhook URL until the retries are exhausted.

Reliable delivery of webhook notifications

Acrobat Sign incorporates an advanced, reliable strategy for delivery of webhook notifications. If there is an outage on the receiving end (suppose, for instance, the customer’s server is down), Acrobat Sign will retry the notification at a later time—minutes or hours later. Undelivered events will be persisted in a retry queue and a best effort will be made over the next 72 hours to deliver the notifications in the order they occurred to the client-provided endpoints. The strategy for retrying delivery of notifications is a doubling of time between attempts, starting with a one-minute interval and doubling the interval with each attempt, up to a maximum interval of 12 hours, resulting in 15 retries in the space of 72 hours. If the webhook fails to respond and either the maximum retry time or the maximum retry interval is exceeded, the webhook will be disabled. No notifications will be sent to the webhook URL until the webhook is activated again; all the notifications between the time the webhook is disabled and enabled again will be lost.

Webhook uniqueness

Acrobat Sign does not allow the creation of duplicate webhooks. The uniqueness of a webhook is based on a combination of the following attributes: - Subscription event - URL - Scope/ResoureType - Resource ID - Application ID/Client ID that you are using for the API call - Creator of webhook (not considered in the cases of group level and account level webhooks) If a webhook’s status is changed from INACTIVE to ACTIVE and another webhook with a similar configuration already exists in the ACTIVE state, the activation call will fail.

SuperSet events

If you want to subscribe for all the agreement, widget or megaSign events, you can subscribe to the following events:

Event type

Description

AGREEMENT_ALL

All the supported agreement events. If new agreement events are added in future, those events will be taken care automatically.

LIBRARY_ALL

For all the supported library document events. If new library document events are added in future that are supported for webhooks, those events will be taken care of automatically.

WIDGET_ALL

All the supported widget events. If new widget events are added in future, those events will be taken care automatically.

MEGASIGN_ALL

All the supported megasign events.

AGREEMENT_ACTION_COMPLETED

Event-specific payload attributes

Parameter Name

Type

Description

Possible Enums

actionType

String

Action type for the event for which Webhook notification is triggered.

ESIGNED, DIGSIGNED, WRITTEN_SIGNED, PRESIGNED, ACCEPTED, SIGNED, APPROVED, DELIVERED, FORM_FILLED, ACKNOWLEDGED, DIGITAL_SIGN_UIDAI_SIGNER_CONSENT

participantUserId

String

The user ID of the action taker. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the action taker. This can be the signer or the delegatee.

actingUserId

String

The user ID of the action taker. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the action taker. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_ACTION_DELEGATED

Event-specific payload attributes

Parameter name

Type

Description

Possible enums

subEvent

String

Subevent for which Webhook notification is triggered.

DELEGATED, AUTO_DELEGATED

participantUserId

String

The user ID of the delegatee.

participantUserEmail

String

The user email of the delegatee.

actingUserId

String

The user ID of the delegator.

actingUserEmail

String

The user email of the delegator.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

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.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

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.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_REPLACED_SIGNER

Event-specific payload attributes

Parameter name

Type

Description

participantUserId

String

The user ID of the replaced signer.

participantUserEmail

String

The user email of the replaced signer.

actingUserId

String

The ID of the originator of the agreement.

actingUserEmail

String

The email of the originator of the agreement.

initiatingUserId

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.

initiatingUserEmail

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.

Payload attributes inherited from agreement

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_REQUESTED

Event-specific payload attributes

Parameter name

Type

Description

participantUserId

String

The user ID of the user to whom the action is requested. User could be the signer or the delegatee.

participantUserEmail

String

The user email of the user to whom the action is requested. User could be the signer or the delegatee.

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.

actingUserEmail

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.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

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.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

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.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
    "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_AUTO_CANCELLED_CONVERSION_PROBLEM

Event-specific payload attributes

Parameter name

Type

Description

participantUserId

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.

participantUserEmail

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.

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.

actingUserEmail

String

When this agreement is created by signing a widget, then this will be details of the creator of the widget.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Payload attributes inherited from agreement

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_CREATED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

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.

participantUserEmail

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.

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.

actingUserEmail

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.

initiatingUserId

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.

initiatingUserEmail

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.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

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.

documentsInfo

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.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_DOCUMENTS_DELETED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

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.

participantUserEmail

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.

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.

actingUserEmail

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.

initiatingUserId

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.

initiatingUserEmail

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.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

conditionalParametersTrimmed

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.

Payload template

{
   "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

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user for which email bounced. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the user for which email bounced. This can be the signer or the delegatee.

actingUserId

String

The user ID of the user for which email bounced. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the user for which email bounced. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user who viewed the email. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the user who viewed the email. This can be the signer or the delegatee.

actingUserId

String

The user ID of the user who viewed the email. This can be the signer or the delegatee.

actingUserEmail

String

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_EXPIRED

Event-specific payload attributes

Parameter Name

Type

Description

Possible Enums

subEvent

String

Subevent for which Webhook notification is triggered.

EXPIRED, EXPIRED_AUTOMATICALLY

participantUserId

String

The user ID of the user for which agreement expired. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the user for which agreement expired. This can be the signer or the delegatee.

actingUserId

String

The user ID of the user for which agreement expired. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the user for which agreement expired. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_KBA_AUTHENTICATED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the authenticated user. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the authenticated user. This can be the signer or the delegatee.

actingUserId

String

The user ID of the authenticated user. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the authenticated user. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_MODIFIED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

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.

participantUserEmail

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.

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.

actingUserEmail

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.

initiatingUserId

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.

initiatingUserEmail

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.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_OFFLINE_SYNC

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user for whom the signing URL is fetched. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the user for whom the signing URL is fetched. This can be the signer or the delegatee.

actingUserId

String

The user ID of the user for whom the signing URL is fetched. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the user for whom the signing URL is fetched. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_RECALLED

Event-specific payload attributes

Parameter Name

Type

Description

Possible Enums

subEvent

String

Subevent for which Webhook notification is triggered.

RECALLED, MAX_SIGNING_KBA_ATTEMPTS_EXCEEDED, MAX_SIGNING_PASSWORD_ATTEMPTS_EXCEEDED, MAX_SIGNING_PHONE_ATTEMPTS_EXCEEDED

participantUserId

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.

participantUserEmail

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.

actingUserEmail

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.

initiatingUserId

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.

initiatingUserEmail

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.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_REJECTED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the action taker. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the action taker. This can be the signer or the delegatee.

actingUserId

String

The user ID of the action taker. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the action taker. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_SHARED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user to whom the agreement is shared.

participantUserEmail

String

The user email of the user to whom the agreement is shared.

actingUserId

String

The user ID of the user by whom the agreement is shared. This can be sender, signer or delegatee.

actingUserEmail

String

The user email of the user by whom the agreement is shared. This can be sender, signer or delegatee.

initiatingUserId

String

The user ID of the sharee of the user on whose behalf this agreement is shared in case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the user on whose behalf this agreement is shared in case of account sharing.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_UPLOADED_BY_SENDER

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user for which signed document is uploaded. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the user for which signed document is uploaded. This can be the signer or the delegatee.

actingUserId

String

The user ID of the originator of the agreement.

actingUserEmail

String

The user email of the originator of the agreement.

initiatingUserId

String

The user ID of the sharee of the originator of the agreement who uploaded the signed document on behalf of originator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the originator of the agreement who uploaded the signed document on behalf of originator in the case of account sharing.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_USER_ACK_AGREEMENT_MODIFIED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user who acknowledged the agreement modifications. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the user who acknowledged the agreement modifications. This can be the signer or the delegatee.

actingUserId

String

The user ID of the user who acknowledged the agreement modifications. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the user who acknowledged the agreement modifications. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_VAULTED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the most recent signing user. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the most recent signing user. This can be the signer or the delegatee.

actingUserId

String

The user ID of the most recent signing user. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the most recent signing user. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_WEB_IDENTITY_AUTHENTICATED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the authenticated user. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the authenticated user. This can be the signer or the delegatee.

actingUserId

String

The user ID of the authenticated user. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the authenticated user. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

nextParticipantSets

Object

Information about the next participant sets.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

conditionalParametersTrimmed

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.

Payload template

{
   "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_WORKFLOW_COMPLETED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the last action taker. This can be the signer or the delegatee.

participantUserEmail

String

The user email of the last action taker. This can be the signer or the delegatee.

actingUserId

String

The user ID of the last action taker. This can be the signer or the delegatee.

actingUserEmail

String

The user email of the last action taker. This can be the signer or the delegatee.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Payload attributes inherited from agreement

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the agreement, which can be used to query status and download signed documents.

name

String

The name of the agreement that will be used to identify it, in emails and on the website.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

ESIGN, WRITTEN

status

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

ccs

Array of Strings

Email IDs of cc: participants of the agreement.

deviceInfo

Object

Device info of the offline device. It will only be returned in the case of offline agreement creation.

documentVisibilityEnabled

Boolean

Determines whether limited document visibility is enabled or not. Will never be returned in offline agreement creation.

createdDate

Date

Agreement creation date.

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through the API.

postSignOption

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.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

workflowId

String

Identifier of the custom workflow that defines the routing path of an agreement. Will not be returned in offline agreement creation.

participantSetsInfo

Object

Returns a list of one or more participant sets. A participant set may have one or more participants. Returned only if conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

documentsInfo

Object

Returns the IDs of the documents of an agreement. Returned only if conditional parameters includeDocumentsInfo is set to true and payload size is less than the threshold.

supportingDocuments

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.

signedDocumentInfo

Object

Base64-encoded signed document

conditionalParametersTrimmed

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.

Payload template

{
   "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":""
      }
   }
}

LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the creator of the library document.

participantUserEmail

String

The user email of the creator of the library document.

actingUserId

String

The user ID of the creator of the library document.

actingUserEmail

String

The user email of the creator of the library document.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Inherited from Library Document:

Parameter name

Type

Description

Possible enums

id

String

The unique identifier that is used to refer to the library template.

name

String

The name of the library template that will be used to identify it, in emails and on the website.

creatorEmail

String

Email of the creator of the library document.

createdDate

Date

Library document creation date.

status

Enum

The current status of the library document.

AUTHORING, ACTIVE, or REMOVED

sharingMode

String

Specifies who should have access to this library document.

USER, GROUP, ACCOUNT, or GLOBAL

templateTypes

String

A list of one or more library template types.

DOCUMENT or FORM_FIELD_LAYER

conditionalParametersTrimmed

String[]

If the 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 parameter 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.

Payload template

{
    "webhookId":"",
    "webhookName":"",
    "webhookNotificationId":"",
    "webhookUrlInfo": {
       "url":""
    },
    "webhookScope":"",
    "webhookNotificationApplicableUsers":[
        {
            "id":"",
            "email":"",
            "role":"",
            "payloadApplicable":""
        }
    ] ,
    "event":"",
    "subEvent":"",
    "eventDate":"",
    "eventResourceType":"",
    "eventResourceParentType":"",
    "eventResourceParentId":"",
    "participantUserId":"",
    "participantUserEmail":"",
    "actingUserId":"",
    "actingUserEmail":"",
    "actingUserIpAddress":"",
    "initiatingUserId":"",
    "initiatingUserEmail":"",
    "libraryDocument" : {
        "id":"",
        "name":"",
        "creatorEmail":"",
        "createdDate":"",
        "status":"",
        "sharingMode":"",
        "templateTypes":[
            ""
        ]
    }
}

LIBRARY_DOCUMENT_CREATED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the creator of the library document.

participantUserEmail

String

The user email of the creator of the library document.

actingUserId

String

The user ID of the creator of the library document.

actingUserEmail

String

The user email of the creator of the library document.

initiatingUserId

String

The user ID of the sharee of the creator of the library document who modified the library document on behalf of the creator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the library document who modified the library document on behalf of the creator in the case of account sharing.

Inherited from Library Document:

Parameter name

Type

Description

Possible enums

id

String

The unique identifier that is used to refer to the library template.

name

String

The name of the library template that will be used to identify it, in emails and on the website.

creatorEmail

String

Email of the creator of the library document.

createdDate

Date

Library document creation date.

status

Enum

The current status of the library document.

AUTHORING, ACTIVE, or REMOVED

sharingMode

String

Specifies who should have access to this library document.

USER, GROUP, ACCOUNT, or GLOBAL

templateTypes

String

A list of one or more library template types.

DOCUMENT or FORM_FIELD_LAYER

documentsInfo

Object

Returns the IDs of the documents of a library document. Returned only if the conditional parameter includeDocumentsInfo is set to true and the 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 /libraryDocuments/{libraryDocumentId}/documents API to get the details of the documents of a library document.

conditionalParametersTrimmed

String[]

If the 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 parameter 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.

Payload template

{
    "webhookId":"",
    "webhookName":"",
    "webhookNotificationId":"",
    "webhookUrlInfo": {
       "url":""
    },
    "webhookScope":"",
    "webhookNotificationApplicableUsers":[
        {
            "id":"",
            "email":"",
            "role":"",
            "payloadApplicable":""
        }
    ] ,
    "event":"",
    "subEvent":"",
    "eventDate":"",
    "eventResourceType":"",
    "eventResourceParentType":"",
    "eventResourceParentId":"",
    "participantUserId":"",
    "participantUserEmail":"",
    "actingUserId":"",
    "actingUserEmail":"",
    "actingUserIpAddress":"",
    "initiatingUserId":"",
    "initiatingUserEmail":"",
    "libraryDocument" : {
        "id":"",
        "name":"",
        "creatorEmail":"",
        "createdDate":"",
        "status":"",
        "sharingMode":"",
        "templateTypes":[
            ""
        ],
       "documentsInfo":{
          "documents":[
             {
                "id":"",
                "label":"",
                "numPages":"",
                "mimeType":"",
                "name":""
             }
          ]
       }
    }
}

LIBRARY_DOCUMENT_MODIFIED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the creator of the library document.

participantUserEmail

String

The user email of the creator of the library document.

actingUserId

String

The user ID of the creator of the library document.

actingUserEmail

String

The user email of the creator of the library document.

initiatingUserId

String

The user ID of the sharee of the creator of the library document who modified the library document on behalf of the creator in the case of account sharing

initiatingUserEmail

String

The user email of the sharee of the creator of the library document who modified the library document on behalf of the creator in the case of account sharing

Inherited from Library Document:

Parameter name

Type

Description

Possible enums

id

String

The unique identifier that is used to refer to the library template.

name

String

The name of the library template that will be used to identify it, in emails and on the website.

creatorEmail

String

Email of the creator of the library document.

createdDate

Date

Library document creation date.

status

Enum

The current status of the library document.

AUTHORING, ACTIVE, or REMOVED

sharingMode

String

Specifies who should have access to this library document.

USER, GROUP, ACCOUNT, or GLOBAL

templateTypes

String

A list of one or more library template types.

DOCUMENT or FORM_FIELD_LAYER

documentsInfo

Object

Returns the IDs of the documents of a library document. Returned only if the conditional parameter includeDocumentsInfo is set to true and the 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 /libraryDocuments/{libraryDocumentId}/documents API to get the details of the documents of a library document.

conditionalParametersTrimmed

String[]

If the 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 parameter 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.

Payload template

{
    "webhookId":"",
    "webhookName":"",
    "webhookNotificationId":"",
    "webhookUrlInfo": {
       "url":""
    },
    "webhookScope":"",
    "webhookNotificationApplicableUsers":[
        {
            "id":"",
            "email":"",
            "role":"",
            "payloadApplicable":""
        }
    ] ,
    "event":"",
    "subEvent":"",
    "eventDate":"",
    "eventResourceType":"",
    "eventResourceParentType":"",
    "eventResourceParentId":"",
    "participantUserId":"",
    "participantUserEmail":"",
    "actingUserId":"",
    "actingUserEmail":"",
    "actingUserIpAddress":"",
    "initiatingUserId":"",
    "initiatingUserEmail":"",
    "libraryDocument" : {
        "id":"",
        "name":"",
        "creatorEmail":"",
        "createdDate":"",
        "status":"",
        "sharingMode":"",
        "templateTypes":[
            ""
        ],
       "documentsInfo":{
          "documents":[
             {
                "id":"",
                "label":"",
                "numPages":"",
                "mimeType":"",
                "name":""
             }
          ]
       }
    }
}

MEGASIGN_CREATED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the creator of the MegaSign.

participantUserEmail

String

The user email of the creator of the MegaSign.

actingUserId

String

The user ID of the creator of the MegaSign.

actingUserEmail

String

The user email of the creator of the MegaSign.

initiatingUserId

String

The user ID of the sharee of the creator of the megasign who created the MegaSign on behalf of the creator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the megasign who created the MegaSign on behalf of the creator in the case of account sharing.

Inherted from MegaSign

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the MegaSign parent agreement.

name

String

The name of the agreement that will be used to identify it in emails, on the website, and elsewhere.

status

Enum

State of the MegaSign.

IN_PROCESS

ccs

Array of Strings

Email IDs of cc: participants of the MegaSign

createdDate

Date

Date when the MegaSign was created, in the format yyyy-MM-dd’T’HH:mm:ssZ

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through API.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided, describing what is being sent or why their signature is required.

postSignOption

Object

Determines the URL and associated properties for the success page to which the user will be taken after completing the signing process.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED or WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

‘ESIGN’ or ‘WRITTEN’

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo": {
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers":[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "megaSign": {
      "name":"",
      "status":"",
      "id":"",
      "ccs": [
         {
            "email":""
         }
      ],
      "createdDate":"",
      "expirationTime":"",
      "externalId": {
         "id":""
      },
      "firstReminderDelay":"",
      "locale":"",
      "message":"",
      "postSignOption": {
         "redirectDelay":"",
         "redirectUrl":""
      },
      "reminderFrequency":"",
      "senderEmail":"",
      "signatureType":"",
      "vaultingInfo": {
         "enabled":""
      }
   }
}

MEGASIGN_RECALLED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the creator of the MegaSign.

participantUserEmail

String

The user email of the creator of the MegaSign.

actingUserId

String

The user ID of the creator of the MegaSign.

actingUserEmail

String

The user email of the creator of the MegaSign.

initiatingUserId

String

The user ID of the sharee of the creator of the MegaSign who recalled the MegaSign on behalf of the creator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the MegaSign who recalled the MegaSign on behalf of the creator in the case of account sharing.

Inherted from MegaSign:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the MegaSign parent agreement.

name

String

The name of the agreement that will be used to identify it in emails, on the website, and elsewhere.

status

Enum

State of the MegaSign.

IN_PROCESS

ccs

Array of Strings

Email IDs of cc: participants of the MegaSign

childAgreementsInfo

Object

Info corresponding to each child agreement of the MegaSign

createdDate

Date

Date when the MegaSign was created, in the format yyyy-MM-dd’T’HH:mm:ssZ

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through API.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided, describing what is being sent or why their signature is required.

postSignOption

Object

Determines the URL and associated properties for the success page to which the user will be taken after completing the signing process.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED or WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

‘ESIGN’ or ‘WRITTEN’

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo": {
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers":[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "megaSign": {
      "name":"",
      "status":"",
      "id":"",
      "ccs": [
         {
            "email":""
         }
      ],
      "childAgreementsInfo": {
         "fileInfo": {
            "fileType":"",
            "childAgreementsInfoFileId":""
         }
      },
      "createdDate":"",
      "expirationTime":"",
      "externalId": {
         "id":""
      },
      "firstReminderDelay":"",
      "locale":"",
      "message":"",
      "postSignOption": {
         "redirectDelay":"",
         "redirectUrl":""
      },
      "reminderFrequency":"",
      "senderEmail":"",
      "signatureType":"",
      "vaultingInfo": {
         "enabled":""
      }
   }
}

MEGASIGN_SHARED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the user to whom the MegaSign is shared.

participantUserEmail

String

The user email of the user to whom the MegaSign is shared.

actingUserId

String

The user ID of the user by whom the MegaSign is shared. This will be creator of the MegaSign.

actingUserEmail

String

The user email of the user by whom the MegaSign is shared. This will be creator of the MegaSign.

initiatingUserId

String

The user ID of the sharee of the user on whose behalf this MegaSign is shared in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the user on whose behalf this MegaSign is shared in the case of account sharing.

Inherted from MegaSign:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of the MegaSign parent agreement.

name

String

The name of the agreement that will be used to identify it in emails, on the website, and elsewhere.

status

Enum

State of the MegaSign.

IN_PROCESS

ccs

Array of Strings

Email IDs of cc: participants of the MegaSign

childAgreementsInfo

Object

Info corresponding to each child agreement of the MegaSign

createdDate

Date

Date when the MegaSign was created, in the format yyyy-MM-dd’T’HH:mm:ssZ

expirationTime

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.

externalId

Object

A unique identifier provided by an external system search for your transaction through API.

firstReminderDelay

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.

locale

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.

message

String

The message associated with the agreement that the sender has provided, describing what is being sent or why their signature is required.

postSignOption

Object

Determines the URL and associated properties for the success page to which the user will be taken after completing the signing process.

reminderFrequency

Enum

Specifies how often reminders will be sent to the recipients.

DAILY_UNTIL_SIGNED or WEEKLY_UNTIL_SIGNED

senderEmail

String

Email of the sender.

signatureType

Enum

Specifies the type of signature requested on the agreement—written or e-signature.

‘ESIGN’ or ‘WRITTEN’

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo": {
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers":[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "megaSign": {
      "name":"",
      "status":"",
      "id":"",
      "ccs": [
         {
            "email":""
         }
      ],
      "childAgreementsInfo": {
         "fileInfo": {
            "fileType":"",
            "childAgreementsInfoFileId":""
         }
      },
      "createdDate":"",
      "expirationTime":"",
      "externalId": {
         "id":""
      },
      "firstReminderDelay":"",
      "locale":"",
      "message":"",
      "postSignOption": {
         "redirectDelay":"",
         "redirectUrl":""
      },
      "reminderFrequency":"",
      "senderEmail":"",
      "signatureType":"",
      "vaultingInfo": {
         "enabled":""
      }
   }
}

WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the widget creator.

participantUserEmail

String

The user email of the widget creator.

actingUserId

String

The user ID of the widget creator.

actingUserEmail

String

The user email of the widget creator.

initiatingUserId

String

Never part of the payload.

initiatingUserEmail

String

Never part of the payload.

Inherted from Widget:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of widget, which can be used to retrieve the data entered by the signers.

name

String

The name of the widget that will be used to identify it, in emails, website, and other places.

status

Enum

The current status of the widget.

DRAFT, AUTHORING, ACTIVE, DOCUMENTS_NOT_YET_PROCESSED, DISABLED, DISCARDED

ccs

Array of Strings

Email IDs of cc: participants of the widget.

authFailureInfo

Object

URL and associated properties for the error page to which the widget signer will be taken after failing to authenticate.

completionInfo

Object

URL and associated properties for the success page to which the widget signer will be taken after performing the desired action on the widget.

disabledWidgetOptions

Object

Specifies the custom message that will be displayed to the user or the URL to which the user will be redirected when the widget is accessed in a disabled state.

creatorEmail

String

Email of of the widget creator.

createdDate

Date

Widget creation date.

locale

String

Locale associated with this widget: specifies the language for the signing page and emails; for example en_US or fr_FR. If none is specified, this defaults to the language configured for the widget creator.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

participantSetsInfo

Object

List of all the participants in the widget except the widget signer. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

widgetParticipantSet

Object

Represents widget participant info for whom email was not provided.

documentsInfo

Object

Retrieves the IDs of the documents associated with widget. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold

conditionalParametersTrimmed

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.

Payload template

{
   "webhookId": "",
   "webhookName":"",
   "webhookNotificationId": "",
   "webhookUrlInfo": {
      "url": ""
   },
   "webhookScope": "",
   "webhookNotificationApplicableUsers" :[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event": "",
   "subEvent": "",
   "eventDate":"",
   "eventResourceType": "",
   "participantUserId": "",
   "participantUserEmail": "",
   "actingUserId": "",
   "actingUserEmail": "",
   "actingUserIpAddress":"",
   "initiatingUserId": "",
   "initiatingUserEmail": "",
   "widget": {
      "name": "",
      "status": "",
      "id": "",
      "authFailureInfo": {
         "url": "",
         "deframe": "",
         "delay": ""
      },
      "ccs": [
         {
            "email": ""
         }
      ],
      "completionInfo": {
         "url": "",
         "deframe": "",
         "delay": ""
      },
      "creatorEmail": "",
      "createdDate": "",
      "locale": "",
      "vaultingInfo": {
         "enabled": ""
      },
      "participantSetsInfo": {
         "additionalParticipantSets": [
            {
               "memberInfos": [
                  {
                     "id": "",
                     "email": "",
                     "company": "",
                     "name": "",
                     "privateMessage": "",
                     "status": ""
                  }
               ],
               "order": "",
               "role": "",
               "id": ""
            }
         ],
         "widgetParticipantSet": {
            "memberInfos": [
               {
                  "id": "",
                  "email": "",
                  "company": "",
                  "name": "",
                  "privateMessage": "",
                  "status": ""
               }
            ],
            "order": "",
            "role": "",
            "id": ""
         }
      }
   }
}

WIDGET_CREATED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the widget creator.

participantUserEmail

String

The user email of the widget creator.

actingUserId

String

The user ID of the widget creator.

actingUserEmail

String

The user email of the widget creator.

initiatingUserId

String

The user ID of the sharee of the creator of the widget who created the widget on behalf of the creator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the widget who created the widget on behalf of the creator in the case of account sharing.

Inherited from Widget:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of widget, which can be used to retrieve the data entered by the signers.

name

String

The name of the widget that will be used to identify it, in emails, website, and other places.

status

Enum

The current status of the widget.

DRAFT, AUTHORING, ACTIVE, DOCUMENTS_NOT_YET_PROCESSED, DISABLED, DISCARDED

ccs

Array of Strings

Email IDs of cc: participants of the widget.

authFailureInfo

Object

URL and associated properties for the error page to which the widget signer will be taken after failing to authenticate.

completionInfo

Object

URL and associated properties for the success page to which the widget signer will be taken after performing the desired action on the widget.

creatorEmail

String

Email of of the widget creator.

createdDate

Date

Widget creation date.

locale

String

Locale associated with this widget: specifies the language for the signing page and emails; for example en_US or fr_FR. If none is specified, this defaults to the language configured for the widget creator.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

participantSetsInfo

Object

List of all the participants in the widget except the widget signer. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

widgetParticipantSet

Object

Represents widget participant info for whom email was not provided.

documentsInfo

Object

Retrieves the IDs of the documents associated with widget. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold

conditionalParametersTrimmed

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.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo":{
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers" :[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "widget":{
      "name":"",
      "status":"",
      "id":"",
      "authFailureInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "ccs":[
         {
            "email":""
         }
      ],
      "completionInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "creatorEmail":"",
      "createdDate":"",
      "locale":"",
      "vaultingInfo":{
         "enabled":""
      },
      "participantSetsInfo":{
         "additionalParticipantSets":[
            {
               "memberInfos":[
                  {
                     "id":"",
                     "email":"",
                     "company":"",
                     "name":"",
                     "privateMessage":"",
                     "status":""
                  }
               ],
               "order":"",
               "role":"",
               "id":""
            }
         ],
         "widgetParticipantSet":{
            "memberInfos":[
               {
                  "id":"",
                  "email":"",
                  "company":"",
                  "name":"",
                  "privateMessage":"",
                  "status":""
               }
            ],
            "order":"",
            "role":"",
            "id":""
         }
      },
      "documentsInfo":{
         "documents":[
            {
               "id":"",
               "label":"",
               "numPages":"",
               "mimeType":"",
               "name":""
            }
         ]
      }
   }
}

WIDGET_DISABLED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the widget creator.

participantUserEmail

String

The user email of the widget creator.

actingUserId

String

The user ID of the widget creator.

actingUserEmail

String

The user email of the widget creator.

initiatingUserId

String

The user ID of the sharee of the creator of the widget who disbaled the widget on behalf of the creator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the widget who disbaled the widget on behalf of the creator in the case of account sharing.

Inherited from Widget:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of widget, which can be used to retrieve the data entered by the signers.

name

String

The name of the widget that will be used to identify it, in emails, website, and other places.

status

Enum

The current status of the widget.

DRAFT, AUTHORING, ACTIVE, DOCUMENTS_NOT_YET_PROCESSED, DISABLED, DISCARDED

ccs

Array of Strings

Email IDs of cc: participants of the widget.

authFailureInfo

Object

URL and associated properties for the error page to which the widget signer will be taken after failing to authenticate.

completionInfo

Object

URL and associated properties for the success page to which the widget signer will be taken after performing the desired action on the widget.

disabledWidgetOptions

Object

Specifies the custom message that will be displayed to the user or the URL to which the user will be redirected when the widget is accessed in a disabled state.

creatorEmail

String

Email of of the widget creator.

createdDate

Date

Widget creation date.

locale

String

Locale associated with this widget: specifies the language for the signing page and emails; for example en_US or fr_FR. If none is specified, this defaults to the language configured for the widget creator.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

participantSetsInfo

Object

List of all the participants in the widget except the widget signer. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

widgetParticipantSet

Object

Represents widget participant info for whom email was not provided.

documentsInfo

Object

Retrieves the IDs of the documents associated with widget. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold

conditionalParametersTrimmed

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.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo":{
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers" :[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "widget":{
      "name":"",
      "status":"",
      "id":"",
      "authFailureInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "ccs":[
         {
            "email":""
         }
      ],
      "completionInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "disabledWidgetOptions":{
         "message":"",
         "redirectUrl":""
      },
      "creatorEmail":"",
      "createdDate":"",
      "locale":"",
      "vaultingInfo":{
         "enabled":""
      },
      "participantSetsInfo":{
         "additionalParticipantSets":[
            {
               "memberInfos":[
                  {
                     "id":"",
                     "email":"",
                     "company":"",
                     "name":"",
                     "privateMessage":"",
                     "status":""
                  }
               ],
               "order":"",
               "role":"",
               "id":""
            }
         ],
         "widgetParticipantSet":{
            "memberInfos":[
               {
                  "id":"",
                  "email":"",
                  "company":"",
                  "name":"",
                  "privateMessage":"",
                  "status":""
               }
            ],
            "order":"",
            "role":"",
            "id":""
         }
      },
      "documentsInfo":{
         "documents":[
            {
               "id":"",
               "label":"",
               "numPages":"",
               "mimeType":"",
               "name":""
            }
         ]
      }
   }
}

WIDGET_ENABLED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the widget creator.

participantUserEmail

String

The user email of the widget creator.

actingUserId

String

The user ID of the widget creator.

actingUserEmail

String

The user email of the widget creator.

initiatingUserId

String

The user ID of the sharee of the creator of the widget who enabled the widget on behalf of the creator in case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the widget who enabled the widget on behalf of the creator in case of account sharing.

Inherited from Widget:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of widget, which can be used to retrieve the data entered by the signers.

name

String

The name of the widget that will be used to identify it, in emails, website, and other places.

status

Enum

The current status of the widget.

DRAFT, AUTHORING, ACTIVE, DOCUMENTS_NOT_YET_PROCESSED, DISABLED, DISCARDED

ccs

Array of Strings

Email IDs of cc: participants of the widget.

authFailureInfo

Object

URL and associated properties for the error page to which the widget signer will be taken after failing to authenticate.

completionInfo

Object

URL and associated properties for the success page to which the widget signer will be taken after performing the desired action on the widget.

creatorEmail

String

Email of of the widget creator.

createdDate

Date

Widget creation date.

locale

String

Locale associated with this widget: specifies the language for the signing page and emails; for example en_US or fr_FR. If none is specified, this defaults to the language configured for the widget creator.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

participantSetsInfo

Object

List of all the participants in the widget except the widget signer. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

widgetParticipantSet

Object

Represents widget participant info for whom email was not provided.

documentsInfo

Object

Retrieves the IDs of the documents associated with widget. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold

conditionalParametersTrimmed

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.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo":{
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers" :[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "widget":{
      "name":"",
      "status":"",
      "id":"",
      "authFailureInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "ccs":[
         {
            "email":""
         }
      ],
      "completionInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "creatorEmail":"",
      "createdDate":"",
      "locale":"",
      "vaultingInfo":{
         "enabled":""
      },
      "participantSetsInfo":{
         "additionalParticipantSets":[
            {
               "memberInfos":[
                  {
                     "id":"",
                     "email":"",
                     "company":"",
                     "name":"",
                     "privateMessage":"",
                     "status":""
                  }
               ],
               "order":"",
               "role":"",
               "id":""
            }
         ],
         "widgetParticipantSet":{
            "memberInfos":[
               {
                  "id":"",
                  "email":"",
                  "company":"",
                  "name":"",
                  "privateMessage":"",
                  "status":""
               }
            ],
            "order":"",
            "role":"",
            "id":""
         }
      },
      "documentsInfo":{
         "documents":[
            {
               "id":"",
               "label":"",
               "numPages":"",
               "mimeType":"",
               "name":""
            }
         ]
      }
   }
}

WIDGET_MODIFIED

Event-specific payload attributes

Parameter Name

Type

Description

participantUserId

String

The user ID of the widget creator.

participantUserEmail

String

The user email of the widget creator.

actingUserId

String

The user ID of the widget creator.

actingUserEmail

String

The user email of the widget creator.

initiatingUserId

String

The user ID of the sharee of the creator of the widget who modified the widget on behalf of the creator in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the creator of the widget who modified the widget on behalf of the creator in the case of account sharing.

Inherted from Widget:

Parameter Name

Type

Description

Possible Enums

id

String

The unique identifier of widget, which can be used to retrieve the data entered by the signers.

name

String

The name of the widget that will be used to identify it, in emails, website, and other places.

status

Enum

The current status of the widget.

DRAFT, AUTHORING, ACTIVE, DOCUMENTS_NOT_YET_PROCESSED, DISABLED, DISCARDED

ccs

Array of Strings

Email IDs of cc: participants of the widget.

authFailureInfo

Object

URL and associated properties for the error page to which the widget signer will be taken after failing to authenticate.

completionInfo

Object

URL and associated properties for the success page to which the widget signer will be taken after performing the desired action on the widget.

disabledWidgetOptions

Object

Specifies the custom message that will be displayed to the user or the URL to which the user will be redirected when the widget is accessed in a disabled state.

creatorEmail

String

Email of of the widget creator.

createdDate

Date

Widget creation date.

locale

String

Locale associated with this widget: specifies the language for the signing page and emails; for example en_US or fr_FR. If none is specified, this defaults to the language configured for the widget creator.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

participantSetsInfo

Object

List of all the participants in the widget except the widget signer. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

widgetParticipantSet

Object

Represents widget participant info for whom email was not provided.

documentsInfo

Object

Retrieves the IDs of the documents associated with widget. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold

conditionalParametersTrimmed

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.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo":{
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers" :[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "widget":{
      "name":"",
      "status":"",
      "id":"",
      "authFailureInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "ccs":[
         {
            "email":""
         }
      ],
      "completionInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "disabledWidgetOptions":{
         "message":"",
         "redirectUrl":""
      },
      "creatorEmail":"",
      "createdDate":"",
      "locale":"",
      "vaultingInfo":{
         "enabled":""
      },
      "participantSetsInfo":{
         "additionalParticipantSets":[
            {
               "memberInfos":[
                  {
                     "id":"",
                     "email":"",
                     "company":"",
                     "name":"",
                     "privateMessage":"",
                     "status":""
                  }
               ],
               "order":"",
               "role":"",
               "id":""
            }
         ],
         "widgetParticipantSet":{
            "memberInfos":[
               {
                  "id":"",
                  "email":"",
                  "company":"",
                  "name":"",
                  "privateMessage":"",
                  "status":""
               }
            ],
            "order":"",
            "role":"",
            "id":""
         }
      },
      "documentsInfo":{
         "documents":[
            {
               "id":"",
               "label":"",
               "numPages":"",
               "mimeType":"",
               "name":""
            }
         ]
      }
   }
}

WIDGET_SHARED

Event-specific payload attributes

Parameter name

Type

Description

participantUserId

String

The user ID of the user to whom the widget is shared.

participantUserEmail

String

The user email of the user to whom the widget is shared.

actingUserId

String

The user ID of the user by whom the widget is shared. This will be creator of the widget.

actingUserEmail

String

The user email of the user by whom the widget is shared. This will be creator of the widget.

initiatingUserId

String

The user ID of the sharee of the user on whose behalf this widget is shared in the case of account sharing.

initiatingUserEmail

String

The user email of the sharee of the user on whose behalf this widget is shared in the case of account sharing.

Inherted from Widget:

Parameter name

Type

Description

Possible enums

id

String

The unique identifier of widget, which can be used to retrieve the data entered by the signers.

name

String

The name of the widget that will be used to identify it, in emails, website, and other places.

status

Enum

The current status of the widget.

DRAFT, AUTHORING, ACTIVE, DOCUMENTS_NOT_YET_PROCESSED, DISABLED, DISCARDED

ccs

Array of Strings

Email IDs of cc: participants of the widget.

authFailureInfo

Object

URL and associated properties for the error page to which the widget signer will be taken after failing to authenticate.

completionInfo

Object

URL and associated properties for the success page to which the widget signer will be taken after performing the desired action on the widget.

disabledWidgetOptions

Object

Specifies the custom message that will be displayed to the user or the URL to which the user will be redirected when the widget is accessed in a disabled state.

creatorEmail

String

Email of of the widget creator.

createdDate

Date

Widget creation date.

locale

String

Locale associated with this widget: specifies the language for the signing page and emails; for example en_US or fr_FR. If none is specified, this defaults to the language configured for the widget creator.

vaultingInfo

Object

Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider.

participantSetsInfo

Object

List of all the participants in the widget except the widget signer. Returned only if the conditional parameter includeParticipantInfo is set to true and the payload size is less than the threshold.

widgetParticipantSet

Object

Represents widget participant info for whom email was not provided.

documentsInfo

Object

Retrieves the IDs of the documents associated with widget. Returned only if the conditional parameter includeDocumentsInfo is set to true and payload size is less than the threshold

conditionalParametersTrimmed

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.

Payload template

{
   "webhookId":"",
   "webhookName":"",
   "webhookNotificationId":"",
   "webhookUrlInfo":{
      "url":""
   },
   "webhookScope":"",
   "webhookNotificationApplicableUsers" :[
    {
      "id":"",
      "email":"",
      "role":"",
      "payloadApplicable":""
     }
   ],
   "event":"",
   "subEvent":"",
   "eventDate":"",
   "eventResourceType":"",
   "participantUserId":"",
   "participantUserEmail":"",
   "actingUserId":"",
   "actingUserEmail":"",
   "actingUserIpAddress":"",
   "initiatingUserId":"",
   "initiatingUserEmail":"",
   "widget":{
      "name":"",
      "status":"",
      "id":"",
      "authFailureInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "ccs":[
         {
            "email":""
         }
      ],
      "completionInfo":{
         "url":"",
         "deframe":"",
         "delay":""
      },
      "disabledWidgetOptions":{
         "message":"",
         "redirectUrl":""
      },
      "creatorEmail":"",
      "createdDate":"",
      "locale":"",
      "vaultingInfo":{
         "enabled":""
      },
      "participantSetsInfo":{
         "additionalParticipantSets":[
            {
               "memberInfos":[
                  {
                     "id":"",
                     "email":"",
                     "company":"",
                     "name":"",
                     "privateMessage":"",
                     "status":""
                  }
               ],
               "order":"",
               "role":"",
               "id":""
            }
         ],
         "widgetParticipantSet":{
            "memberInfos":[
               {
                  "id":"",
                  "email":"",
                  "company":"",
                  "name":"",
                  "privateMessage":"",
                  "status":""
               }
            ],
            "order":"",
            "role":"",
            "id":""
         }
      },
      "documentsInfo":{
         "documents":[
            {
               "id":"",
               "label":"",
               "numPages":"",
               "mimeType":"",
               "name":""
            }
         ]
      }
   }
}