A single document signing published a series of events
Would be nice with a description as to what the expected ordering should be
E.g: will i receive a payload notifying me of document_singed before document_packaged ?
Thanks!
Hi,
If you have all the events enabled it would follow this order: (excluding the first two and deleted/expired)
The other events, cancelled, before_deleted and deleted will happen if these events are triggered.
Events listed in no particular order
GET https://api.signicat.io/notification/events/types
[
{
"id": "document_before_deleted",
"name": "Document before deleted",
"description": "When a document is about to be deleted."
},
{
"id": "document_canceled",
"name": "Document canceled",
"description": "When a document is canceled."
},
{
"id": "document_created",
"name": "Document created",
"description": "When a new document is created."
},
{
"id": "document_deleted",
"name": "Document deleted",
"description": "When a document is deleted."
},
{
"id": "document_expired",
"name": "Document expired",
"description": "When a document expires."
},
{
"id": "document_email_opened",
"name": "Document email opened",
"description": "When a signer opens a document email."
},
{
"id": "document_form_partially_signed",
"name": "Document form partially signed",
"description": "When a form is partially signed."
},
{
"id": "document_form_signed",
"name": "Document form signed",
"description": "When a form is signed by all required signers."
},
{
"id": "document_link_opened",
"name": "Document link opened",
"description": "When a document link is opened by a signer."
},
{
"id": "document_packaged",
"name": "Document packaged",
"description": "When a document is packaged with all signatures."
},
{
"id": "document_partially_signed",
"name": "Document partially signed",
"description": "When a document is partially signed."
},
{
"id": "document_read",
"name": "Document read",
"description": "When a document is read by a signer."
},
{
"id": "document_signed",
"name": "Document signed",
"description": "When a document is signed by all required signers."
},
{
"id": "resource_created",
"name": "Resource created",
"description": "When a resource is created and available for download."
},
{
"id": "share_created",
"name": "Share created",
"description": "When a new share is created."
},
{
"id": "share_deleted",
"name": "Share deleted",
"description": "When a share is deleted."
},
{
"id": "share_recipients_authenticated",
"name": "Share recipients authenticated",
"description": "When a Receipient successfully authenticated."
},
{
"id": "share_recipient_downloaded",
"name": "Share recipient downloaded",
"description": "When a recipient downloaded from share."
},
{
"id": "share_downloaded",
"name": "Share downloaded",
"description": "When all shares have been downloaded."
},
{
"id": "share_expired",
"name": "Share expired",
"description": "When a share expires and are being cleaned up."
},
{
"id": "deposit_created",
"name": "Deposit created",
"description": "When a new deposit is created."
},
{
"id": "deposit_terminated",
"name": "Deposit terminated",
"description": "When a deposit is terminated."
},
{
"id": "deposit_fully_funded",
"name": "Deposit fully funded",
"description": "When full payment has been made to the deposit."
},
{
"id": "deposit_partially_funded",
"name": "Deposit partially funded",
"description": "When partial payment has been made to the deposit."
},
{
"id": "deposit_bank_account_created",
"name": "Deposit bank account created",
"description": "When a bank account is created."
},
{
"id": "self_declaration_assignment_created",
"name": "Self declaration assignment created",
"description": "When a new self declaration assignment is created."
},
{
"id": "self_declaration_opened",
"name": "Self declaration opened",
"description": "When a self declaration link is opened."
},
{
"id": "self_declaration_finished",
"name": "Self declaration finished",
"description": "When a self declaration is finished."
},
{
"id": "self_declaration_assignment_finished",
"name": "Self declaration assignment finished",
"description": "When a self declaration assignment is finished."
},
{
"id": "email_delivered",
"name": "Email delivered",
"description": "When the email was successfully delivered to the recipient"
},
{
"id": "email_failed",
"name": "Email failed",
"description": "When the email failed to be delivered to the recipient"
},
{
"id": "email_opened",
"name": "Email opened",
"description": "When the recipient has opened the email"
},
{
"id": "sms_delivered",
"name": "Sms delivered",
"description": "When the sms was successfully delivered to the recipient"
},
{
"id": "sms_failed",
"name": "Sms failed",
"description": "When the sms failed to be delivered to the recipient"
},
{
"id": "person_monitor_changes",
"name": "Person monitor changes",
"description": "When new changes are added to the monitor."
},
{
"id": "self_declaration_assignment_deleted",
"name": "Self declaration assignment deleted",
"description": "When a self declaration assignment is deleted."
},
{
"id": "self_declaration_assignment_expired",
"name": "Self declaration assignment expired",
"description": "When a self declaration expires before it is completed by all persons."
}
]