Event types
Recipient events
Recipient events track key actions and status changes for recipients within an envelope, such as when a recipient is sent a request, completes their part, or is replaced. This page describes each event type, when it occurs, and the additional data you can expect in the event payload.
recipient.released
Therecipient.released event is triggered when a recipient is ready to be sent a request. The recipient status changes to pending.
Example event payload
Example event payload
JSON
recipient.sent
Therecipient.sent event is triggered when a request is sent to a recipient.
Example event payload
Example event payload
JSON
recipient.completed
Therecipient.completed event is triggered when a recipient has completed their part of the signing process. The recipient status changes to completed.
Example event payload
Example event payload
JSON
recipient.rejected
Therecipient.rejected event is triggered when a recipient rejects the envelope.
If the recipient provided a reason for the rejection, it appears in the reason property. If no reason was given, the reason property is null.
Example event payload
Example event payload
JSON
recipient.soft_bounced
Therecipient.soft_bounced event is triggered when a recipient’s email is temporarily undeliverable (for example, due to a full mailbox). The event data includes a detail property with more information.
Example event payload
Example event payload
JSON
recipient.hard_bounced
Therecipient.hard_bounced event is triggered when a recipient’s email is permanently undeliverable (for example, due to an invalid email address).
The event data includes a detail property with additional information about the bounce. You can view further details, such as SMTP responses, in the Dashboard.
If a signer’s email address hard bounces, you cannot send additional requests to that signer. To proceed, use the Replace Recipient endpoint to remove the affected signer from the envelope and add a new signer with a valid email address.
Example event payload
Example event payload
JSON
recipient.failed
Therecipient.failed event is triggered when there is a failure related to a recipient. The event data includes a detail property with more information about the failure.
Example event payload
Example event payload
JSON
recipient.replaced
Therecipient.replaced event is triggered when a recipient is replaced with a new one.
The event data includes a new_recipient_id property, which provides the ID of the new recipient, and a new_recipient_name property, which provides the name of the new recipient.
Example event payload
Example event payload
JSON
recipient.resent
Therecipient.resent event is triggered when a request is resent to a recipient.
Example event payload
Example event payload
JSON