> ## Documentation Index
> Fetch the complete documentation index at: https://signatureapi-daf4ee54.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/docs/api/resources/events/envelope-events#envelope-completed) and a [recipient email bouncing](/docs/api/resources/events/recipient-events#recipient-hard-bounced).

You receive events as webhook notifications. You can also retrieve them through the API, either [for all events in your account](/docs/api/resources/events/all) or for a [specific envelope](/docs/api/resources/events/envelope) or [recipient](/docs/api/resources/events/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.

<Note>Events may arrive out of order. Your application should handle this gracefully. See [Webhooks](/docs/api/webhooks) for delivery details.</Note>

## Attributes

<ResponseField name="id" type="string">
  The unique identifier of the event. Uses the `evt_` prefix.
</ResponseField>

<ResponseField name="type" 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:

  * [Envelope Events](/docs/api/resources/events/envelope-events)
  * [Recipient Events](/docs/api/resources/events/recipient-events)
  * [Deliverable Events](/docs/api/resources/events/deliverable-events)
  * [Sender Events](/docs/api/resources/events/sender-events)
</ResponseField>

<ResponseField name="timestamp" type="string">
  When the event occurred, in <Tooltip tip="For example: 2025-12-31T23:59:59.999Z">ISO 8601</Tooltip> format.
</ResponseField>

<ResponseField name="data" type="object">
  The data associated with the event. The shape of this object depends on the event `type`.

  <Expandable title="Envelope event data" defaultOpen={false}>
    <Info>These properties are common to all envelope events. Some event types include additional properties. See [Envelope Events](/docs/api/resources/events/envelope-events) for details.</Info>

    <ResponseField name="object_id" type="string">
      The unique identifier of the resource this event refers to. For envelope events, this value is the envelope ID.
    </ResponseField>

    <ResponseField name="object_type" type="enum">
      The type of resource this event refers to. For envelope events, the value is `envelope`.
    </ResponseField>

    <ResponseField name="envelope_id" type="string">
      The ID of the envelope this event refers to. For envelope events, this value is the same as `object_id`.
    </ResponseField>

    <ResponseField name="envelope_metadata" type="object">
      The metadata attached to the envelope.
    </ResponseField>
  </Expandable>

  <Expandable title="Recipient event data" defaultOpen={false}>
    <Info>These properties are common to all recipient events. Some event types include additional properties. See [Recipient Events](/docs/api/resources/events/recipient-events) for details.</Info>

    <ResponseField name="object_id" type="string">
      The unique identifier of the resource this event refers to. For recipient events, this value is the recipient ID.
    </ResponseField>

    <ResponseField name="object_type" type="enum">
      The type of resource this event refers to. For recipient events, the value is `recipient`.
    </ResponseField>

    <ResponseField name="envelope_id" type="string">
      The ID of the envelope the recipient belongs to.
    </ResponseField>

    <ResponseField name="envelope_metadata" type="object">
      The metadata attached to the envelope the recipient belongs to.
    </ResponseField>

    <ResponseField name="recipient_type" type="enum">
      The type of the recipient. Possible values: `signer`, `approver`, `preparer`.
    </ResponseField>

    <ResponseField name="recipient_key" type="string">
      A user-provided key that identifies the recipient within an envelope.
    </ResponseField>
  </Expandable>

  <Expandable title="Deliverable event data" defaultOpen={false}>
    <Info>These properties are common to all deliverable events. Some event types include additional properties. See [Deliverable Events](/docs/api/resources/events/deliverable-events) for details.</Info>

    <ResponseField name="object_id" type="string">
      The unique identifier of the resource this event refers to. For deliverable events, this value is the deliverable ID.
    </ResponseField>

    <ResponseField name="object_type" type="enum">
      The type of resource this event refers to. For deliverable events, the value is `deliverable`.
    </ResponseField>

    <ResponseField name="envelope_id" type="string">
      The ID of the envelope the deliverable belongs to.
    </ResponseField>

    <ResponseField name="envelope_metadata" type="object">
      The metadata attached to the envelope the deliverable belongs to.
    </ResponseField>

    <ResponseField name="deliverable_type" type="enum">
      The type of the deliverable. Possible values: `simple`, `standard`.
    </ResponseField>

    <ResponseField name="deliverable_name" type="string | null">
      A user-provided name for the deliverable.
    </ResponseField>

    <ResponseField name="included_documents" type="array">
      The keys of the documents included in the deliverable.
    </ResponseField>
  </Expandable>

  <Expandable title="Sender event data" defaultOpen={false}>
    <Info>These properties are common to all sender events. Some event types include additional properties. See [Sender Events](/docs/api/resources/events/sender-events) for details.</Info>

    <ResponseField name="object_id" type="string">
      The unique identifier of the sender this event refers to.
    </ResponseField>

    <ResponseField name="object_type" type="enum">
      The type of resource this event refers to. For sender events, the value is `sender`.
    </ResponseField>

    <ResponseField name="email" type="string">
      The email address of the sender this event refers to.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Response theme={null}
  {
    "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"
    }
  }
  ```
</ResponseExample>