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 .
Attributes The unique identifier of the event. Uses the evt_ prefix.
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: When the event occurred, in ISO 8601
The data associated with the event. The shape of this object depends on the event type. These properties are common to all envelope events. Some event types include additional properties. See
Envelope Events for details.
The unique identifier of the resource this event refers to. For envelope events, this 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, this value is the same as object_id.
The metadata attached to the envelope.
Show Recipient event data
These properties are common to all recipient events. Some event types include additional properties. See
Recipient Events for details.
The unique identifier of the resource this event refers to. For recipient events, this 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 attached to the envelope the recipient belongs to.
The type of the recipient. Possible values: signer, approver, preparer.
A user-provided key that identifies the recipient within an envelope.
Show Deliverable event data
These properties are common to all deliverable events. Some event types include additional properties. See
Deliverable Events for details.
The unique identifier of the resource this event refers to. For deliverable events, this 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 attached to the envelope the deliverable belongs to.
The type of the deliverable. Possible values: simple, standard.
A user-provided name for the deliverable.
The keys of the documents included in the deliverable.
These properties are common to all sender events. Some event types include additional properties. See
Sender Events for details.
The unique identifier of the sender this event refers to.
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" : { "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" } }
