Event types
Envelope events
Envelope events track key changes in the lifecycle of an envelope, such as creation, completion, or failure. This page describes each event type, when it occurs, and the additional data you can expect in the event payload.
envelope.created
Theenvelope.created event is triggered when you create a new envelope.
Example event payload
Example event payload
JSON
envelope.started
Theenvelope.started event indicates that the envelope is ready to be sent to recipients. At this point, the envelope status changes from processing to in_progress.
Example event payload
Example event payload
JSON
envelope.completed
Theenvelope.completed event is triggered when all recipients have completed (for example, signed) the envelope. At this point, the envelope status changes from in_progress to completed.
Example event payload
Example event payload
JSON
envelope.failed
Theenvelope.failed event is triggered when an envelope fails, resulting in a status of failed. Use this event to handle errors or notify users of issues.
The data object in the event payload includes a detail field that provides information about the failure.
Envelope failures are very rare. If an envelope fails, SignatureAPI engineers receive an automatic alert and begin investigating the issue. You can contact support for assistance or additional information about the failure.
Example event payload
Example event payload
JSON
envelope.canceled
Theenvelope.canceled event is triggered when the envelope is explicitly cancelled by calling the Cancel Envelope endpoint. The resulting envelope status is canceled, which is a terminal state.
If a reason was provided in the cancel envelope request, the data object in the event payload includes a reason property with that value. If no reason was provided, the reason property is null.
Example event payload
Example event payload
JSON