Last updated on
20 Dec 2021
Agreement Events
Agreement all events
This is a superset of all events for the Agreement object.
Agreement created (AGREEMENT_CREATED)
{
"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 sent (AGREEMENT_ACTION_REQUESTED)
{
"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 participant completed (AGREEMENT_ACTION_COMPLETED)
{
"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 workflow completed (AGREEMENT_WORKFLOW_COMPLETED)
{
"webhookId":"",
"webhookName":"",
"webhookNotificationId":"",
"webhookUrlInfo":{
"url":""
},
"webhookScope":"",
"webhookNotificationApplicableUsers":[
{
"id":"",
"email":"",
"role":"",
"payloadApplicable":""
}
],
"event":"",
"subEvent":"",
"eventDate":"",
"eventResourceType":"",
"eventResourceParentType":"",
"eventResourceParentId":"",
"participantRole":"",
"participantUserId":"",
"participantUserEmail":"",
"actingUserId":"",
"actingUserEmail":"",
"actingUserIpAddress":"",
"initiatingUserId":"",
"initiatingUserEmail":"",
"agreement":{
"id":"",
"name":"",
"signatureType":"",
"status":"",
"ccs":[
{
"email":"",
"label":"",
"visiblePages":[
""
]
}
],
"deviceInfo":{
"applicationDescription":"",
"deviceDescription":"",
"location":{
"latitude":"",
"longitude":""
},
"deviceTime":""
},
"documentVisibilityEnabled":"",
"createdDate":"",
"expirationTime":"",
"externalId":{
"id":""
},
"postSignOption":{
"redirectDelay":"",
"redirectUrl":""
},
"firstReminderDelay":"",
"locale":"",
"message":"",
"reminderFrequency":"",
"senderEmail":"",
"vaultingInfo":{
"enabled":""
},
"workflowId":"",
"participantSetsInfo":{
"participantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
]
},
"documentsInfo":{
"documents":[
{
"id":"",
"label":"",
"numPages":"",
"mimeType":"",
"name":""
}
],
"supportingDocuments":[
{
"displayLabel":"",
"fieldName":"",
"id":"",
"mimeType":"",
"numPages":""
}
]
},
"signedDocumentInfo":{
"document":""
}
}
}
Agreement expired (AGREEMENT_EXPIRED)
{
"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 deleted (AGREEMENT_DOCUMENTS_DELETED)
{
"webhookId":"",
"webhookName":"",
"webhookNotificationId":"",
"webhookUrlInfo":{
"url":""
},
"webhookScope":"",
"webhookNotificationApplicableUsers":[
{
"id":"",
"email":"",
"role":"",
"payloadApplicable":""
}
],
"event":"",
"subEvent":"",
"eventDate":"",
"eventResourceType":"",
"eventResourceParentType":"",
"eventResourceParentId":"",
"participantUserId":"",
"participantUserEmail":"",
"actingUserId":"",
"actingUserEmail":"",
"actingUserIpAddress":"",
"initiatingUserId":"",
"initiatingUserEmail":"",
"agreement":{
"id":"",
"name":"",
"signatureType":"",
"status":"",
"ccs":[
{
"email":"",
"label":"",
"visiblePages":[
""
]
}
],
"deviceInfo":{
"applicationDescription":"",
"deviceDescription":"",
"location":{
"latitude":"",
"longitude":""
},
"deviceTime":""
},
"documentVisibilityEnabled":"",
"createdDate":"",
"expirationTime":"",
"externalId":{
"id":""
},
"postSignOption":{
"redirectDelay":"",
"redirectUrl":""
},
"firstReminderDelay":"",
"locale":"",
"message":"",
"reminderFrequency":"",
"senderEmail":"",
"vaultingInfo":{
"enabled":""
},
"workflowId":"",
"participantSetsInfo":{
"participantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
]
}
}
}
Agreement canceled (AGREEMENT_RECALLED)
{
"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 (AGREEMENT_REJECTED)
{
"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 (AGREEMENT_SHARED)
{
"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 delegated (AGREEMENT_ACTION_DELEGATED)
{
"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 participant replaced (AGREEMENT_ACTION_REPLACED_SIGNER)
{
"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 (AGREEMENT_MODIFIED)
{
"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 modification acknowledged (AGREEMENT_USER_ACK_AGREEMENT_MODIFIED)
{
"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 (AGREEMENT_EMAIL_VIEWED)
{
"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 bounced (AGREEMENT_EMAIL_BOUNCED)
{
"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 creation failed (AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM)
{
"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":""
}
}
}
}
Agreement synced post offline event (AGREEMENT_OFFLINE_SYNC)
{
"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 (AGREEMENT_UPLOADED_BY_SENDER)
{
"webhookId":"",
"webhookName":"",
"webhookNotificationId":"",
"webhookUrlInfo":{
"url":""
},
"webhookScope":"",
"webhookNotificationApplicableUsers":[
{
"id":"",
"email":"",
"role":"",
"payloadApplicable":""
}
],
"event":"",
"subEvent":"",
"eventDate":"",
"eventResourceType":"",
"eventResourceParentType":"",
"eventResourceParentId":"",
"participantUserId":"",
"participantUserEmail":"",
"actingUserId":"",
"actingUserEmail":"",
"actingUserIpAddress":"",
"initiatingUserId":"",
"initiatingUserEmail":"",
"agreement":{
"id":"",
"name":"",
"signatureType":"",
"status":"",
"ccs":[
{
"email":"",
"label":"",
"visiblePages":[
""
]
}
],
"deviceInfo":{
"applicationDescription":"",
"deviceDescription":"",
"location":{
"latitude":"",
"longitude":""
},
"deviceTime":""
},
"documentVisibilityEnabled":"",
"createdDate":"",
"expirationTime":"",
"externalId":{
"id":""
},
"postSignOption":{
"redirectDelay":"",
"redirectUrl":""
},
"firstReminderDelay":"",
"locale":"",
"message":"",
"reminderFrequency":"",
"senderEmail":"",
"vaultingInfo":{
"enabled":""
},
"workflowId":"",
"participantSetsInfo":{
"participantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
],
"nextParticipantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
]
},
"documentsInfo":{
"documents":[
{
"id":"",
"label":"",
"numPages":"",
"mimeType":"",
"name":""
}
],
"supportingDocuments":[
{
"displayLabel":"",
"fieldName":"",
"id":"",
"mimeType":"",
"numPages":""
}
]
}
}
}
Agreement ready to vault (AGREEMENT_READY_TO_VAULT)
{
"webhookId":"",
"webhookName":"",
"webhookNotificationId":"",
"webhookUrlInfo":{
"url":""
},
"webhookScope":"",
"webhookNotificationApplicableUsers":[
{
"id":"",
"email":"",
"role":"",
"payloadApplicable":""
}
],
"event":"",
"subEvent":"",
"eventDate":"",
"eventResourceType":"",
"eventResourceParentType":"",
"eventResourceParentId":"",
"participantUserId":"",
"participantUserEmail":"",
"actingUserId":"",
"actingUserEmail":"",
"actingUserIpAddress":"",
"initiatingUserId":"",
"initiatingUserEmail":"",
"agreement":{
"id":"",
"name":"",
"signatureType":"",
"status":"",
"ccs":[
{
"email":"",
"label":"",
"visiblePages":[
""
]
}
],
"deviceInfo":{
"applicationDescription":"",
"deviceDescription":"",
"location":{
"latitude":"",
"longitude":""
},
"deviceTime":""
},
"documentVisibilityEnabled":"",
"createdDate":"",
"expirationTime":"",
"externalId":{
"id":""
},
"postSignOption":{
"redirectDelay":"",
"redirectUrl":""
},
"firstReminderDelay":"",
"locale":"",
"message":"",
"reminderFrequency":"",
"senderEmail":"",
"vaultingInfo":{
"enabled":""
},
"workflowId":"",
"participantSetsInfo":{
"participantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
]
},
"documentsInfo":{
"documents":[
{
"id":"",
"label":"",
"numPages":"",
"mimeType":"",
"name":""
}
],
"supportingDocuments":[
{
"displayLabel":"",
"fieldName":"",
"id":"",
"mimeType":"",
"numPages":""
}
]
}
}
}
Agreement vaulted (AGREEMENT_VAULTED)
{
"webhookId":"",
"webhookName":"",
"webhookNotificationId":"",
"webhookUrlInfo":{
"url":""
},
"webhookScope":"",
"webhookNotificationApplicableUsers":[
{
"id":"",
"email":"",
"role":"",
"payloadApplicable":""
}
],
"event":"",
"subEvent":"",
"eventDate":"",
"eventResourceType":"",
"eventResourceParentType":"",
"eventResourceParentId":"",
"participantUserId":"",
"participantUserEmail":"",
"actingUserId":"",
"actingUserEmail":"",
"actingUserIpAddress":"",
"initiatingUserId":"",
"initiatingUserEmail":"",
"agreement":{
"id":"",
"name":"",
"signatureType":"",
"status":"",
"ccs":[
{
"email":"",
"label":"",
"visiblePages":[
""
]
}
],
"deviceInfo":{
"applicationDescription":"",
"deviceDescription":"",
"location":{
"latitude":"",
"longitude":""
},
"deviceTime":""
},
"documentVisibilityEnabled":"",
"createdDate":"",
"expirationTime":"",
"externalId":{
"id":""
},
"postSignOption":{
"redirectDelay":"",
"redirectUrl":""
},
"firstReminderDelay":"",
"locale":"",
"message":"",
"reminderFrequency":"",
"senderEmail":"",
"vaultingInfo":{
"enabled":""
},
"workflowId":"",
"participantSetsInfo":{
"participantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
]
},
"documentsInfo":{
"documents":[
{
"id":"",
"label":"",
"numPages":"",
"mimeType":"",
"name":""
}
],
"supportingDocuments":[
{
"displayLabel":"",
"fieldName":"",
"id":"",
"mimeType":"",
"numPages":""
}
]
}
}
}
Agreement participant social identity authenticated (AGREEMENT_WEB_IDENTITY_AUTHENTICATED)
{
"webhookId":"",
"webhookName":"",
"webhookNotificationId":"",
"webhookUrlInfo":{
"url":""
},
"webhookScope":"",
"webhookNotificationApplicableUsers":[
{
"id":"",
"email":"",
"role":"",
"payloadApplicable":""
}
],
"event":"",
"subEvent":"",
"eventDate":"",
"eventResourceType":"",
"eventResourceParentType":"",
"eventResourceParentId":"",
"participantUserId":"",
"participantUserEmail":"",
"actingUserId":"",
"actingUserEmail":"",
"actingUserIpAddress":"",
"initiatingUserId":"",
"initiatingUserEmail":"",
"agreement":{
"id":"",
"name":"",
"signatureType":"",
"status":"",
"ccs":[
{
"email":"",
"label":"",
"visiblePages":[
""
]
}
],
"deviceInfo":{
"applicationDescription":"",
"deviceDescription":"",
"location":{
"latitude":"",
"longitude":""
},
"deviceTime":""
},
"documentVisibilityEnabled":"",
"createdDate":"",
"expirationTime":"",
"externalId":{
"id":""
},
"postSignOption":{
"redirectDelay":"",
"redirectUrl":""
},
"firstReminderDelay":"",
"locale":"",
"message":"",
"reminderFrequency":"",
"senderEmail":"",
"vaultingInfo":{
"enabled":""
},
"workflowId":"",
"participantSetsInfo":{
"participantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
],
"nextParticipantSets":[
{
"memberInfos":[
{
"id":"",
"email":"",
"company":"",
"name":"",
"privateMessage":"",
"status":""
}
],
"order":"",
"role":"",
"status":"",
"id":"",
"name":"",
"privateMessage":""
}
]
},
"documentsInfo":{
"documents":[
{
"id":"",
"label":"",
"numPages":"",
"mimeType":"",
"name":""
}
],
"supportingDocuments":[
{
"displayLabel":"",
"fieldName":"",
"id":"",
"mimeType":"",
"numPages":""
}
]
}
}
}
Agreement participant KBA authenticated (AGREEMENT_KBA_AUTHENTICATED)
{
"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":""
}
]
}
}
}
Mega Sign Events
Mega Sign all events
This is a superset of all events for the Mega Sign object.
Mega Sign created (MEGASIGN_CREATED)
{
"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":""
}
}
}
Mega Sign shared (MEGASIGN_SHARED)
{
"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":""
}
}
}
Mega Sign recalled (MEGASIGN_RECALLED)
{
"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":""
}
}
}
Web form Events
Widget all events
Widget created (WIDGET_CREATED)
{
"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 enabled (WIDGET_ENABLED)
{
"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 (WIDGET_DISABLED)
{
"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 (WIDGET_MODIFIED)
{
"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 shared (WIDGET_SHARED)
{
"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 creation failed (WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM)
{
"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":""
}
}
}
}
