Webhook event triggers | Docusign

You can configure Docusign Connect to send notification messages to your app in response to any or all of the following events.

Envelope events

envelope-sent: This event is sent when the email notification, with a link to the envelope, is sent to at least one recipient or when it is a recipient’s turn to sign during Embedded signing. The envelope remains in this state until all recipients have viewed the envelope. In Legacy event message formats, this event is called Sent.
envelope-delivered: This event is sent when all recipients have opened the envelope through the Docusign signing website. This does not signify an email delivery of an envelope. In Legacy event message formats, this event is called Delivered.

This event is typically triggered when the Continue button is selected in an eSignature workflow. Note that, if Electronic Record and Signature Disclosure (ERSD) is required by your account, this event will only trigger after the user agrees to the ERSD, because the Continue button will not be selectable until that time.
envelope-completed: The envelope has been completed by all the recipients. In Legacy event message formats, this event is called Completed.
envelope-created: This event is sent when an envelope is created through the Docusign eSignature UI or when an envelope’s status is set to created after an Envelopes:create API call. Only available in JSON SIM message format.
envelope-declined: The envelope has been declined by one of the recipients. In Legacy event message formats, this event is called Declined.
envelope-voided: The envelope has been voided by the sender or has expired. The void reason indicates whether the envelope was manually voided or expired. In Legacy event message formats, this event is called Voided.
envelope-resent: Sent when the envelope is resent within the UI or via the Envelopes:update API call. Only available in JSON SIM message format.
envelope-removed: Sent after Docusign permanently deletes an envelope, either when a draft envelope exceeds the 30-120 day draft retention period set for the account or when an envelope in the purge queue is permanently deleted after the 14-day retention period. This action permanently removes documents and their field data from Docusign servers. Available only in JSON SIM event model message format.
envelope-corrected: Sent when the envelope is corrected within the UI or via any of the Envelopes/EnvelopesRecipients API calls. Only available in JSON SIM message format.

Note: This event can only be generated in the API after an envelope lock is created prior to the envelope update, then subsequently removed.
envelope-purge: Sent when the envelope is queued to be purged or via the Envelopes:update API call. Only available in JSON SIM message format.

Note: The Purge queue has four states that will populate within the purgeState parameter within the envelope summary.
- documents_queued
- documents_and_metadata_queued
- documents_and_metadata_and_redact_queued
- documents_dequeued
envelope-deleted: This event is sent after an already-sent envelope is deleted. Only available in JSON SIM message format.

Note: This event will not trigger for envelopes in created or draft state.
envelope-discard: Sent when an envelope in created or draft state is deleted or discarded within the tagging UI. Only available in JSON SIM message format.
envelope-reminder-sent: Sent when the automated reminders feature sends out a reminder for a specific envelope. Available only in JSON SIM event model message format.

Recipient events

recipient-sent: This event is sent when an email notification is sent to the recipient signifying that it is their turn to sign an envelope. In Legacy event message formats, this event is called Sent.
recipient-autoresponded: Sent when Docusign gets notification that an email delivery has failed. The delivery failure could be for a number of reasons, such as a bad email address or that the recipient’s email system auto-responds to the email from Docusign. In Legacy event message formats, this event is called AutoResponded.
recipient-delivered: Sent when the recipient has viewed the document(s) in an envelope through the Docusign signing web site. This does not signify an email delivery of an envelope. In Legacy event message formats, this event is called Delivered.

This event is typically triggered when the Continue button is selected in an eSignature workflow. Note that, if Electronic Record and Signature Disclosure (ERSD) is required by your account, this event will only trigger after the user agrees to the ERSD, because the Continue button will not be selectable until that time.
recipient-completed: Sent when the recipient has completed their actions for the envelope, typically (but not always) by signing. In Legacy event message formats, this event is called Completed.
recipient-declined: Sent when the recipient declines to sign the document(s) in the envelope. In Legacy event message formats, this event is called Declined.
recipient-authenticationfailed: Sent when the recipient fails an authentication check. In cases where a recipient has multiple attempts to pass a check, it means that the recipient failed all the attempts. In Legacy event message formats, this event is called AuthenticationFailed.
recipient-resent: Triggered when an envelope is resent to a recipient within the web application or using the EnvelopeRecipients : update API call. Only available in JSON SIM message format.
recipient-delegate: Sent after a Delegation rule is in place and when a delegated signer is sent an envelope within the UI or the API. Only available in JSON SIM message format.
recipient-reassign: Sent when the envelope is reassigned by a recipient within the UI. Only available in JSON SIM message format.
recipient-finish-later: Sent when the recipient selects Finish Later on an envelope. Only available in JSON SIM message format.

Template events

template-created: Sent when a template is created within the UI or via the Templates:create API call. Only available in JSON SIM message format.
template-modified: Sent when a template is modified within the UI or via the Templates:update API call. Only available in JSON SIM message format.
template-deleted: Sent when a template is deleted within the UI or via the recycle bin API call . Only available in JSON SIM message format.

Elastic template events

click-agreed: Sent after a recipient accepts an elastic template. Only available in JSON SIM message format.
click-declined: Sent after a recipient declines an elastic template. Only available in JSON SIM message format.

SMS events

sms-opt-in: Sent after a recipient opts in to receive SMS notifications for an envelope. Only available in JSON SIM message format.
sms-opt-out: Sent after a recipient opts out of receiving SMS notifications for an envelope. Only available in JSON SIM message format.

IDV for EU QES events

identity-verification-pending: Triggered when the recipient finishes all of the EU QES for IDV challenges.
identity-verification-completed: Triggered when Docusign receives the final EU QES for IDV challenges results. If the authentication result is failure, the event’s errorReason field will contain a value indicating why authentication failed.

Workflow Builder events

workflow-started: Sent after a participant has been enrolled into a Workflow Builder API workflow. Only available in JSON SIM message format.
workflow-failed: Sent after a participant has failed any of their individual workflow steps. Only available in JSON SIM message format.
workflow-completed: Sent after a participant has completed all workflow steps. Only available in JSON SIM message format.

Extension app events

extension-executed: This event is used by data verification extensions, and is sent after your recipient has completed the data verification process.

You can use this event to help troubleshoot verification failures: if a data verification extension app returns an optional providerResponseCode, its value will be mapped to the passthroughResponseData property of this event. This enables you to automate workflows in response to specific failure response codes and maintain detailed logs. Only available in JSON SIM message format.

Notary events

These events apply to the Notary On-Demand feature:

notary-session-completed: Sent after all participants in a notary group have completed signing.
notary-session-terminated: Sent if a notary session cannot be completed and the notary terminates the session, or if the signer refuses to sign. Includes the termination reason supplied by the notary.
notary-session-signer-locked: Sent after a notary session participant has reached their knowledge-based authentication (KBA) attempt limit.
notary-session-signer-unlocked: Sent after the KBA lockout period has ended (24 hours after lockout).
notary-session-authentication-failed: Sent after a notary session participant fails any step of the identity verification workflow.
notary-session-paused: Stay informed when a notary pauses a session. This event can be crucial for monitoring session progress and making necessary adjustments.
notary-session-status-updated: Receive notifications when the status of a session has been updated. This can include changes such as session initiation, completion, or any other status-related event.
notary-session-notary-assigned: Get alerted when the notary for a session is assigned. This can be important for tracking who is responsible for a particular session.
notary-session-notary-removed: Get alerted when the notary for a session is removed. This can be important for tracking who is responsible for a particular session.
notary-session-ondemand-witness-joined: Receive notifications when an on-demand witness joins the session and capture how long it took for the witness to accept the request and join.

Timing of envelope and recipient events

The recipient-sent event occurs first, and then the envelope is marked as sent. If you’re using Send Individual Messages (SIM), you will receive the recipient event before the envelope event. If you’re using Aggregate, you will usually receive them together as one event. This also applies to other closely related events.

Next steps

Workspace events

workspace-upload-request-created: Generated when a workspace upload request is created.
workspace-upload-request-completed: Generated when a workspace upload request is completed.
workspace-upload-request-sent: Generated when a workspace upload request is sent.