Event types
Sender events
Track sender email verification lifecycle events including creation, verification, failure, and deletion
Sender events track the lifecycle of email address verification for senders. Each event includes a data object with the sender’s object_id and email.
Event types
| Event | When it fires |
|---|---|
sender.created | A sender was created and the verification email was sent |
sender.verified | The address owner completed email verification |
sender.failed | Verification failed due to a bounce or error |
sender.deleted | A sender was deleted from the account |
sender.created
Fires when a new sender is created and the verification email is sent. The sender starts in pending_verification status. Listen for sender.verified or sender.failed to track the verification outcome.
Example event payload
Example event payload
sender.verified
Fires when a sender completes email verification. The sender status is now verified. SignatureAPI can send signing requests on behalf of this address.
Example event payload
Example event payload
sender.failed
Fires when sender email verification fails. This can happen due to a soft or hard bounce of the verification email, or an internal error. The data.detail property contains a human-readable explanation of the failure reason.
Example event payload
Example event payload
sender.deleted
Fires when a sender is deleted from the account. SignatureAPI can no longer send signing requests on behalf of this address.
Example event payload
Example event payload