Events
The Event object
Attributes
idstringUnique identifier of the object (prefixed, opaque).
objectstringeventtypestringapi_versionstringcreatedintegerTime at which the object was created (unix timestamp, seconds).
livemodebooleantruefor live data,falsefor the test-mode sandbox.brandstringnullableThe brand the object belongs to (
br_…).dataobjectShow child attributes
objectobjectString representing the object type.
previous_attributesobject
{
"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
eventstringrequiredEvent id (
evt_…).
Returns
Returns the event object. Raises an error if something goes wrong.
curl
curl https://api.skoup.ai/v1/events/evt_034wK3aZBwxdUFxpXoBNdT \
-H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"{
"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
typestringbrandstringlimitintegerNumber of objects to return, between 1 and 100 (default 20).
starting_afterstringCursor: the
idof 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
curl https://api.skoup.ai/v1/events?limit=3 \
-H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"{
"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": {}
}
}
]
}