​
id
string

The unique identifier of the event.

​
type
enum

The type of the event. For a list of event types, see Event Types.

​
timestamp
timestamp

Time at which the event occurred, in ISO 8601 format.

​
data
object

The data associated with the event.

Below is the standard data for all events. Some event types include extra data. For more details on the data for each event type, see Event Types.

​
envelope_id
string

The unique identifier of the envelope this event refers to.

If the event concerns a sub-resource (such as a recipient or a deliverable), this field contains the ID of the envelope to which the sub-resource belongs.

​
object_id
string

The unique identifier of the resource this event refers to.

For example, if the event is about a recipient, this field will contain the recipient’s ID.

​
object_type
enum

The type of resource this event refers to.

Possible values are envelope, recipient, and deliverable.

Was this page helpful?

Create a ceremonyEvent types