SignatureAPI
Mint Starter Kit

Events

Event

The event object records changes and actions in your account, delivered via webhooks or retrievable through the API.

Events record changes and actions in your SignatureAPI account. Examples include an envelope completing and a recipient email bouncing.

You receive events as webhook notifications. You can also retrieve them through the API, either for all events in your account or for a specific envelope or recipient.

Typical event flow

A standard signing flow produces events in this order:

  1. envelope.created: Envelope is created and processing begins.
  2. envelope.started: Processing complete, recipients are being notified.
  3. recipient.released: Recipient is ready to receive an invitation.
  4. recipient.sent: Invitation email delivered (only when delivery_type is email).
  5. recipient.accessed: Recipient opens the ceremony URL.
  6. recipient.viewed: Recipient authenticates and views the documents.
  7. recipient.completed: Recipient finishes signing.
  8. envelope.completed: All recipients done, envelope is complete.
  9. deliverable.generated: Signed PDF is ready for download.

For sequential routing, steps 3-7 repeat for each recipient in order. For parallel routing, multiple recipients go through steps 3-7 at the same time.

Events may arrive out of order. Your application should handle this gracefully. See Webhooks for delivery details.

Attributes

​
id
string

The unique identifier of the event. Uses the evt_ prefix.

​
type
enum

The type of the event. Determines the category and the shape of the data payload.

Event types are grouped into four categories: envelope, recipient, deliverable, and sender.

For the full list of event types, see:

​
timestamp
string

When the event occurred, in format.

​
data
object

The data associated with the event. The shape of this object depends on the event type.

{
  "id": "evt_4p2oouvNvjp1I9ckgqycH2",
  "type": "recipient.completed",
  "timestamp": "2025-12-31T15:00:01.999Z",
  "data": {
    "object_id": "re_7v7Sion0vqjJioYmwfZ9mf",
    "object_type": "recipient",
    "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
    "envelope_metadata": {
      "deal_id": "50055",
      "deal_owner": "Jane C."
    },
    "recipient_type": "signer",
    "recipient_key": "client",
    "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72"
  }
}