Skip to Content

Events

The Event object

Attributes

  • idstring

    Unique identifier of the object (prefixed, opaque).

  • objectstring

    event

  • typestring
  • api_versionstring
  • createdinteger

    Time at which the object was created (unix timestamp, seconds).

  • livemodeboolean

    true for live data, false for the test-mode sandbox.

  • brandstringnullable

    The brand the object belongs to (br_…).

  • dataobject
    Show child attributes
    • objectobject

      String representing the object type.

    • previous_attributesobject
The Event object
{ "id": "evt_034wK3aZBwxdUFxpXoBNdT", "object": "event", "type": "string", "api_version": "v1", "created": 1790000000, "livemode": true, "brand": "br_034CyfRFSXUqzrbzV6MAfZ", "data": { "object": {}, "previous_attributes": {} } }

Retrieve an event

GET/v1/events/{event}

Parameters

  • eventstringrequired

    Event id (evt_…).

Returns

Returns the event object. Raises an error if something goes wrong.

curl https://api.skoup.ai/v1/events/evt_034wK3aZBwxdUFxpXoBNdT \ -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"
Response
{ "id": "evt_034wK3aZBwxdUFxpXoBNdT", "object": "event", "type": "string", "api_version": "v1", "created": 1790000000, "livemode": true, "brand": "br_034CyfRFSXUqzrbzV6MAfZ", "data": { "object": {}, "previous_attributes": {} } }

List events

GET/v1/events

Events of the last 30 days, newest first — the same objects your webhook endpoints receive. Use it to catch up after downtime.

Parameters

  • typestring
  • brandstring
  • limitinteger

    Number of objects to return, between 1 and 100 (default 20).

  • starting_afterstring

    Cursor: the id of the last object of the previous page.

Returns

A dictionary with a data property holding up to limit event objects, newest first, and has_more telling whether another page exists. Raises an error if something goes wrong.

curl https://api.skoup.ai/v1/events?limit=3 \ -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"
Response
{ "object": "list", "url": "/v1/events", "has_more": false, "data": [ { "id": "evt_034wK3aZBwxdUFxpXoBNdT", "object": "event", "type": "string", "api_version": "v1", "created": 1790000000, "livemode": true, "brand": "br_034CyfRFSXUqzrbzV6MAfZ", "data": { "object": {}, "previous_attributes": {} } } ] }
Last updated on