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.
The unique identifier of the event.
The type of the event. For the list of event types, see: Time at which the event occurred, in ISO 8601
The data associated with the event. These are properties that are common to all envelope events. Some event types include additional properties. See
Envelope Events for more details.
The unique identifier of the resource this event refers to. For envelope events, the value is the envelope ID.
The type of resource this event refers to. For envelope events, the value is envelope.
The ID of the envelope this event refers to. For envelope events, the value is the same as the object_id field.
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.
The unique identifier of the resource this event refers to. For recipient events, the value is the recipient ID.
The type of resource this event refers to. For recipient events, the value is recipient.
The ID of the envelope the recipient belongs to.
The metadata of the envelope the recipient belongs to.
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.
The unique identifier of the resource this event refers to. For deliverable events, the value is the deliverable ID.
The type of resource this event refers to. For deliverable events, the value is deliverable.
The ID of the envelope the deliverable belongs to.
The metadata of the envelope the deliverable belongs to.
These are properties that are common to all sender events. Some event types include additional properties. See
Sender Events for more details.
The unique identifier of the resource this event refers to. For sender events, the value is the sender ID.
The type of resource this event refers to. For sender events, the value is sender.
The email address of the sender this event refers to.
{ "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" } } 
