Event

{
  "id": "evt_4p2oouvNvjp1I9ckgqycH2",
  "type": "recipient.completed",
  "timestamp": "2025-12-31T15:00:01.999Z",
  "data": {
    "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
    "object_id": "re_7v7Sion0vqjJioYmwfZ9mf",
    "object_type": "recipient",
    "recipient_key": "client"
 }
}

Event objects record changes or actions in your SignatureAPI account, such as when an envelope is completed or when a request email to a recipient bounces.

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

This page explains the structure of an event object and describes the properties included in event payloads across the API.

string

The unique identifier of the event.

type

enum

The type of the event.

For the list of event types, see:

timestamp

Time at which the event occurred, in format.

data

object

The data associated with the event.

Show Envelope Event Data

These are properties that are common to all envelope events. Some event types include additional properties. See Envelope Events for more details.

object_id

string

The unique identifier of the resource this event refers to.

For envelope events, the value is the envelope ID.

object_type

enum

The type of resource this event refers to.

For envelope events, the value is envelope.

envelope_id

string

The ID of the envelope this event refers to.

For envelope events, the value is the same as the object_id field.

envelope_metadata

object

The metadata of the envelope this event refers to.

Show Recipient Event Data

These are properties that are common to all recipient events. Some event types include additional properties. See Recipient Events for more details.

object_id

string

The unique identifier of the resource this event refers to.

For recipient events, the value is the recipient ID.

object_type

enum

The type of resource this event refers to.

For recipient events, the value is recipient.

envelope_id

string

The ID of the envelope the recipient belongs to.

envelope_metadata

object

The metadata of the envelope the recipient belongs to.

recipient_key

string

The unique key of the recipient within the envelope.

Show Deliverable Event Data

These are properties that are common to all deliverable events. Some event types include additional properties. See Deliverable Events for more details.

object_id

string

The unique identifier of the resource this event refers to.

For deliverable events, the value is the deliverable ID.

object_type

enum

The type of resource this event refers to.

For deliverable events, the value is deliverable.

envelope_id

string

The ID of the envelope the deliverable belongs to.

envelope_metadata

object

The metadata of the envelope the deliverable belongs to.

Show Sender Event Data

These are properties that are common to all sender events. Some event types include additional properties. See Sender Events for more details.

object_id

string

The unique identifier of the resource this event refers to.

For sender events, the value is the sender ID.

object_type

enum

The type of resource this event refers to.

For sender events, the value is sender.

{
  "id": "evt_4p2oouvNvjp1I9ckgqycH2",
  "type": "recipient.completed",
  "timestamp": "2025-12-31T15:00:01.999Z",
  "data": {
    "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
    "object_id": "re_7v7Sion0vqjJioYmwfZ9mf",
    "object_type": "recipient",
    "recipient_key": "client"
 }
}

Create a ceremony Envelope events

{
  "id": "evt_4p2oouvNvjp1I9ckgqycH2",
  "type": "recipient.completed",
  "timestamp": "2025-12-31T15:00:01.999Z",
  "data": {
    "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
    "object_id": "re_7v7Sion0vqjJioYmwfZ9mf",
    "object_type": "recipient",
    "recipient_key": "client"
 }
}

Introduction

Reference

Explore

Envelopes

Recipients

Documents

Places

Deliverables

Ceremonies

Events

Files

Senders