submitted followed by delivered or failed.
Private instances configured with an SMTP server will only receive the
submitted event unless the failure occurs while sending.Example
Payload
{
"notificationId": "1ad50d25-5d04-4e11-b1f0-8078b22986ce",
"packageId": "24428e41-8b96-40cc-96e6-b74c7c539fcb",
"documentId": null,
"template": "package_sign",
"type": "email",
"state": "submitted",
"action": "notification_status",
"eventId": "60c25aef-19d7-40f1-b428-d049aa549450",
"eventTime": "2022-02-23T20:19:31.540923Z"
}
Show Notification types
Show Notification types
| Value | Description |
|---|---|
| Notification was sent via email | |
| sms | Notification was sent via SMS |
Show Notification states
Show Notification states
| Value | Description |
|---|---|
| submitted | Notification was submitted for delivery |
| delivered | Notification was delivered successfully |
| failed | Notification delivery failed |
Show Notification templates
Show Notification templates
| Value | Description |
|---|---|
| package_cancelled | Notification that a package has been cancelled |
| package_created | Notification that a package has been created |
| package_declined | Notification that a package has been declined |
| package_executed | Notification that a package has been executed |
| package_export_failed | Notification that a package export has failed |
| package_forwarded | Notification that a package has been forwarded |
| package_future_reminder | Reminder notification for a package |
| package_masterfile_link | Notification containing a link to the package masterfile |
| package_meeting | Notification for a package meeting |
| package_meeting_cancelled | Notification that a package meeting has been cancelled |
| package_notification | General notification related to a package |
| package_notification_failed | Notification that a package notification failed |
| package_rescinded | Notification that a package has been rescinded |
| package_review_link | Notification containing a link to review the package |
| package_sign | Notification to sign a package |
| package_sign_witness | Notification to sign a package with a witness |
| package_updated | Notification that a package has been updated |
| document_accessed | Notification that a document has been accessed |
| document_executed | Notification that a document has been executed |
| document_executed_all | Notification that a document has been executed by all signers |
| document_next | Notification that a document is next to be signed |
| document_reminder | Reminder notification to sign a document |
| document_signed | Notification that a document has been signed |
| document_signer_link | Notification containing a link for the signer to sign the document |
| mobile_link | Notification contains a link to open the signature pad on a mobile device |
| verification_completed | Notification that identity verification has been completed |
| verification_failed | Notification that identity verification has failed |
| verification_first | Notification that identity verification is required before signing or meeting |
| verification_link | Notification containing a link to complete identity verification |