The Event object v2
Attributes
- id string Unique identifier for the event.
- object string, value is "v2.core.event" String representing the object’s type. Objects of the same type share the same value of the object field.
- changes nullable object Before and after changes for the primary related object.
- context nullable string Authentication context needed to fetch the event or related object.
- created timestamp Time at which the object was created.
- data nullable object Additional data about the event.
- livemode boolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - reason nullable object Reason for the event.
- related _ object nullable object Object containing the reference to API resource relevant to the event.
- type string The type of the event.
The Event object
Retrieve an Event v2
GET / v2 / core / events /:id
Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which might have been delivered to your event destination.
Learn more about calling API v2 endpoints.
Parameters
No parameters.
Returns
Returns an Event object.
Error Codes
404 not _ found
The resource wasn’t found.
Response
List Events v2
GET / v2 / core / events
List events, going back up to 30 days.
Learn more about calling API v2 endpoints.
Parameters
- created object Set of filters to query events within a range of
createdtimestamps. - limit integer The page size.
- object _ id string Primary object ID used to retrieve related events.
- page string The requested page.
- types array of strings An array of up to 20 strings containing specific event names.
Returns
Response attributes
- data array of objects List of events.
- next _ page _ url nullable string URL to fetch the next page of the list. If there are no more pages, the value is null.
- previous _ page _ url nullable string URL to fetch the previous page of the list. If there are no previous pages, the value is null.
Response