Events overviewMenu
On this page

Events

An event is something a contact did, such as Order Completed, with properties describing it. Events start journeys, feed segment rules and conversion goals; they are not webhook events, which Kirora sends to you. Send each with an Idempotency-Key from your own event id, and keep event names fixed (a varying value belongs in properties), since a workspace holds at most 1,000 names. See Events. A contact's events: GET /v1/contacts/{id}/events.

Endpoints

EndpointRequest
Track an eventPOST /v1/events/track
Track events in a batchPOST /v1/events/batch
List eventsGET /v1/events
List the event catalogueGET /v1/events/catalog
Retrieve an event's summaryGET /v1/events/summary
Retrieve an event's time seriesGET /v1/events/series
Define or describe an event namePUT /v1/events/catalog/{name}
Delete an event name and its eventsDELETE /v1/events/catalog/{name}
List the standard event namesGET /v1/events/standard-names

The TrackedEvent object

TrackedEvent example
{
  "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
  "occurredAt": "2030-03-14T09:30:00Z",
  "expiresAt": "2030-03-14T09:30:00Z"
}
idstringrequired

uuid

occurredAtstringrequired

date-time

expiresAtstringrequired

When retention deletes it: when it happened plus the days the plan kept events when it was stored. Fixed: a plan change moves only later events.

date-time