The event object

Events are our way of letting you know when something interesting happens in your account. Events are important triggers in your account on which decisions or actions depend. Events occur when the state of a resource changes. These events could be triggered/logged with a synchronous activity, like when you hit an API or for an asynchronous activity, like a payment made by a customer. For example, when a checkout link is created, a checkout-link.created event is created; and when a checkout link is paid, a checkout_link.paid event is created.

Note that many API requests may create multiple events because a certain event may trigger other system driven events. For example, if you create a new checkout link for a customer, checkout_link.created event, checkout_session.created event, and a payment.created event is created.

When an event occurs, we create a new event object. Each event object is structured to have an event_type, id, and related Speed resource nested under data. Each event data is rendered according to the Speed version at its creation time, specified in the event object api_version attribute. Right now, the event data is retained for 30 days. Afterward, the data is either archived or deleted.

We also have a separate webhooks functionality for sending the events directly to an endpoint defined by you.

Response

{
  "id": "evt_xxxxxxxxxxxxxxxxxxxx",
  "object": "events",
  "api_version": "2022-10-15",
  "event_type": "payment.expired",
  "data": {
    "object": {
      "id": "object_id_xxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "object": "object_name"
    }
  },
  "livemode": false,
  "request": {
    "id": "NL_xxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "created": 1673515123417,
  "modified": 1673515123417
}

Attributes

id string
Unique identifier for the object.

object string
The type of the object indicates to which entity this response belongs.

api_version string
Speed version at the time of this event’s creation.

event_type string
Specifies the event which occurred.

data string
This is an object containing the resource for which events is triggered having information regarding the change in the resource’s state.

livemode boolean
If the object is in live mode, it has the value true; otherwise, it has the value false.

request string
This is an object containing the information on the API request that triggered the event.

created timestamp
Time at which the event object was created.

modified timestamp
Time at which the last modification was made.