Events v2

Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate thin events which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. Retrieve the event object for additional data about the event. Use the related object ID in the event payload to fetch the API resource of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload. You can access events through the Retrieve Event API for 30 days.

Learn more about calling API v2 endpoints.

Was this section helpful? Yes No

Retrieve an Event

GET / v2 / core / events /:id

List Events

GET / v2 / core / events

Ping an Event Destination

POST / v2 / core / event_destinations /:id / ping

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 true if the object exists in live mode or the value false if 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