Webhook event reference
Every event type you can subscribe to, grouped by resource.
Subscribe to exact types, to a whole resource with envelope.* / recipient.* / approval.*, or to everything with *. New types are added over time and never renamed, so match on the exact string and ignore types you do not handle. See Webhooks for payloads, signatures and retries.
Envelope
| Event | When |
|---|---|
envelope.sent | Envelope sent |
envelope.delivered | Envelope delivered |
envelope.bounced | Envelope email bounced |
envelope.viewed | Envelope viewed |
envelope.in_progress | Envelope in progress |
envelope.pending | Envelope pending |
envelope.partially_signed | Envelope partially signed |
envelope.completed | Envelope completed |
envelope.declined | Envelope declined |
envelope.expired | Envelope expired |
envelope.voided | Envelope voided |
envelope.on_hold | Envelope put on hold |
envelope.archived | Envelope archived |
envelope.recalled | Envelope recalled to draft |
envelope.failed | Envelope failed |
Recipient
| Event | When |
|---|---|
recipient.sent | Recipient emailed |
recipient.delivered | Recipient email delivered |
recipient.bounced | Recipient email bounced |
recipient.viewed | Recipient viewed |
recipient.in_progress | Recipient started signing |
recipient.signed | Recipient signed |
recipient.declined | Recipient declined |
recipient.delegated | Recipient delegated |
recipient.cancelled | Recipient cancelled |
Approval
| Event | When |
|---|---|
approval.approved | Approval granted |
approval.rejected | Approval rejected |
approval.changes_requested | Approval: changes requested |
Other
| Event | When |
|---|---|
reminder.sent | Reminder sent |
sign_form.submitted | Sign form submitted |
bulk_send.completed | Bulk send completed |
Diagnostics
| Event | When |
|---|---|
webhook.test | Test delivery |