Bulk Signing Events¶
Tip
The Sign in Bulk feature was previously named “Megasign”. Hence the use of “megasign” in code samples, event names, and the REST APIs.
Common payload elements¶
Minimum payload for bulk signing events¶
The following returns for a bulk signing event if all the conditional parameters are set to false while creating webhooks:
Parameter name |
Type |
Description |
Possible enums |
|
String |
The unique identifier of the agreement; it can be used to query status and download signed documents. |
|
|
String |
The name of the agreement that will be used to identify it, in emails and on the website. |
|
|
Enum |
The current status of the agreement. |
OUT_FOR_SIGNATURE, SIGNED, APPROVED, ACCEPTED, DELIVERED, FORM_FILLED, ABORTED, EXPIRED, OUT_FOR_APPROVAL, OUT_FOR_ACCEPTANCE, OUT_FOR_DELIVERY, OUT_FOR_FORM_FILLING, or CANCELLED |
|
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 |
For different Send in Bulk events, the detailed agreement info, participant info, document info, and the signed document returns based on the conditional parameters specified during webhook creation.
Payload attributes inherited from MegaSign¶
Parameter name |
Type |
Description |
Possible Enums |
|---|---|---|---|
|
String |
The unique identifier of the bulk signing parent agreement. |
|
|
String |
The name of the agreement that will be used to identify it in emails, on the website, and elsewhere. |
|
|
Enum |
State of the bulk signing event. |
IN_PROCESS |
|
Array of Strings |
Email IDs of cc: participants of the bulk signing event |
|
|
Date |
Date when the bulk signing event was created, in the format yyyy-MM-dd’T’HH:mm:ssZ |
|
|
Timestamp |
The date after which the agreement can no longer be signed, if an expiration date is configured. The value is nil if an expiration date is not set for the document. |
|
|
Object |
A unique identifier provided by an external system search for your transaction through API. |
|
|
integer |
Integer which specifies the delay in hours before sending the first reminder. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference between the agreement creation time and the expiration time of the agreement in hours. If this is not specified while creating the agreement, but the reminder frequency is specified, then the first reminder will be sent based on frequency: in other words, if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Will never be returned in offline agreement creation. |
|
|
String |
The locale associated with this agreement. Specifies the language for the signing page and emails: for example, en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender. |
|
|
String |
The message associated with the agreement that the sender has provided, describing what is being sent or why their signature is required. |
|
|
Object |
Determines the URL and associated properties for the success page to which the user will be taken after completing the signing process. |
|
|
Enum |
Specifies how often reminders will be sent to the recipients. |
DAILY_UNTIL_SIGNED or WEEKLY_UNTIL_SIGNED |
|
String |
Email of the sender. |
|
|
Enum |
Specifies the type of signature requested on the agreement—written or e-signature. |
‘ESIGN’ or ‘WRITTEN’ |
|
Object |
Specifies the vaulting properties that allow Acrobat Sign to securely store documents with a vault provider. |
MEGASIGN_ALL¶
If you want to subscribe to all library events, subscribe to MEGASIGN_ALL.
Tip
MEGASIGN_ALL retrieves all agreement events, including events added in the future.
MEGASIGN_CREATED¶
Web app name: Send in Bulk created
Triggers when a bulk signing event is created.
Parameter name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the creator of the bulk signing event. |
|
String |
The user email of the creator of the bulk signing event. |
|
String |
The user ID of the creator of the bulk signing event. |
|
String |
The user email of the creator of the bulk signing event. |
|
String |
The user ID of the sharee of the creator of the megasign who created the bulk signing event on behalf of the creator in the case of account sharing. |
|
String |
The user email of the sharee of the creator of the megasign who created the bulk signing event on behalf of the creator in the case of account sharing. |
{
"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¶
Updated: July, 2023
Web app name: Send in Bulk recalled
Triggers when a send in bulk action is recalled
Parameter name |
Type |
Description |
|---|---|---|
|
String |
The user ID of the creator of the bulk signing event. |
|
String |
The user email of the creator of the bulk signing event. |
|
String |
The user ID of the creator of the bulk signing event. |
|
String |
The user email of the creator of the bulk signing event. |
|
String |
The user ID of the sharee of the creator of the bulk signing event who recalled the bulk signing event on behalf of the creator in the case of account sharing. |
|
String |
The user email of the sharee of the creator of the bulk signing event who recalled the bulk signing event on behalf of the creator in the case of account sharing. |
|
String |
Any arbitrary comment. |
|
Boolean |
True or false (default) depending on whether recipients should be notified that the transaction(s) have been cancelled. This field is set when an agreement is cancelled using the |
{
"webhookId": "",
"webhookName": "",
"webhookNotificationId": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"eventDate": "",
"eventResourceType": "",
"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": ""
}
},
"agreementCancellationInfo": {
"comment": "",
"notifyOthers": ""
}
}
MEGASIGN_REMINDER_INITIATED¶
Introduced: November 8, 2022
Web app name: Send in Bulk reminder initiated
Triggers when a Send in Bulk reminder is triggered and reminder emails are suppressed (the default) ( Unlike MEGASIGN_REMINDER_SENT webhook fires when reminder emails are enabled). Only one MEGASIGN_REMINDER_INITIATED (or MEGASIGN_REMINDER_SENT) webhook is delivered for the parent Send in Bulk container. Individual child agreements do not each fire a MEGASIGN_REMINDER_INITIATED webhook.
{
"webhookId": "",
"webhookNotificationId": "",
"webhookName": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"webhookNotificationApplicableUsers": [
{
"id": "",
"email": "",
"role": "",
"payloadApplicable": ""
}
],
"event": "",
"subEvent": "",
"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": ""
}
},
"reminderInfo": {
"id": "",
"note": "",
"allUnsigned": "",
"participantList": [
{
"participantUserId": "",
"id": "",
"email": ""
}
]
}
}
MEGASIGN_REMINDER_SENT¶
Introduced: November 8, 2022
Web app name: Send in Bulk reminder sent
Triggers when a Send in Bulk reminder is triggered and reminder emails are enabled (default).
{
"webhookId": "",
"webhookNotificationId": "",
"webhookName": "",
"webhookUrlInfo": {
"url": ""
},
"webhookScope": "",
"event": "",
"subEvent": "",
"eventResourceType": "",
"participantUserId": "",
"participantUserEmail": "",
"actingUserId": "",
"actingUserEmail": "",
"initiatingUserId": "",
"initiatingUserEmail": "",
"megaSign": {
"name": "",
"status": "",
"id": "",
"ccs": [
{
"email": ""
}
],
"createdDate": "",
"expirationTime": "",
"externalId": {
"id": ""
},
"firstReminderDelay": "",
"locale": "",
"message": "",
"postSignOption": {
"redirectDelay": "",
"redirectUrl": ""
},
"reminderFrequency": "",
"senderEmail": "",
"signatureType": "",
"vaultingInfo": {
"enabled": ""
}
},
"reminderInfo": {
"id": "",
"note": "",
"allUnsigned": "",
"participantList": [
{
"participantUserId": "",
"id": "",
"email": ""
}
]
}
}