Event types

This is a list of the types of events SignatureAPI produces.

​

Envelope Events

​

envelope.created

This event occurs whenever an Envelope is created.

​

envelope.started

This event occurs when an envelope status transitions from processing to in_progress, indicating it is ready to be sent to recipients.

​

envelope.completed

This event occurs when an envelope status transitions from in_progress to completed, indicating it has been completed by all recipients.

​

envelope.failed

This event occurs when an envelope fails, resulting in an envelope status of failed.

In addition to the standard event data, this event includes a detail field that provides information about the failure.

​

envelope.canceled

This event occurs when the signing process has been intentionally stopped before completion, resulting in an envelope status of canceled.

​

Recipient Events

​

recipient.sent

This event occurs when a request is sent to a recipient.

​

recipient.completed

This event occurs when a recipient has completed their part of the signing process.

In addition to the standard event data, this event includes a recipient_type field that specifies the type of recipient.

​

recipient.rejected

This event occurs when a recipient rejects the envelope.

In addition to the standard event data, this event includes a recipient_type field that specifies the type of recipient and a reason field that provides the recipient’s explanation for the rejection.

​

recipient.soft_bounced

This event occurs when a recipient’s email is temporarily undeliverable, typically due to issues like a full mailbox or out-of-office automatic reply.

In addition to the standard event data, this event includes a recipient_type field that specifies the type of recipient and a detail field that provides information about the bounce.

​

recipient.hard_bounced

This event occurs when a recipient’s email is permanently undeliverable, typically due to issues like an invalid email address.

In addition to the standard event data, this event includes a recipient_type field that specifies the type of recipient and a detail field that provides information about the bounce.

​

recipient.failed

This event occurs when there is a failure related to a recipient, resulting in a recipient status of failed.

In addition to the standard event data, this event includes a recipient_type field that specifies the type of recipient and a detail field that provides information about the failure.

​

recipient.replaced

This event occurs when a recipient is replaced with a new one.

In addition to the standard event data, this event includes a recipient_type field that specifies the type of recipient and a new_recipient_id field that provides the ID of the new recipient.

​

recipient.resent

This event occurs when a request is resent to a recipient.

​

Deliverable Events

​

deliverable.generated

This event occurs when a deliverable, such as an audit log, is successfully generated.

In addition to the standard event data, this event includes a url field that provides the URL for downloading the deliverable. This URL is intended for immediate use because it will expire.

​

deliverable.failed

This event occurs when the generation of a deliverable fails, resulting in a deliverable status of failed.

In addition to the standard event data, this event includes a detail field that provides information about the failure.

​

Sender Events

In addition to the standard event data, sender events includes an email field with the email address of the sender.

​

sender.created

This event occurs when a sender verification request is created.

​

sender.verified

This event occurs when a sender verification request is completed successfully.

​

sender.failed

This event happens when a sender verification fails. This can be due to a soft or hard bounce of the verification request email, or because of an internal error.

The data property includes a detail property that provides more information about this issue.

​

sender.deleted

This event occurs when a sender is deleted.