Sign in

v1

latestOpenAPI 3.0.02026-07-241220330.3 KB
Events

Get an event by token

Retrieves a previously submitted event by its event request token, including the original request body.

get/events/{event_request_token}

Path parameters

event_request_tokenstring required
Example:EV-xi7Etep0gW7gZiuWsqXG

The event request token returned when the event was created.

Response

Event found

event_request_tokenstring
event_typestring

The type of event that was submitted.

events_api_type_idinteger

Internal numeric identifier for the event type.

event_status_idinteger nullable

Internal identifier for the event status, if one was assigned.

event_lifecycle_idstring nullable

Lifecycle identifier for grouping related events.

external_event_idstring nullable

External event identifier provided in the original request.

event_request_status_type_idinteger nullable

Status type of the event request (e.g. processed, error).

event_request_sourcestring nullable

Source of the event request (e.g. API, batch ingestion).

ingestion_batch_tokenstring nullable

Token of the ingestion batch, if the event was submitted via batch.

upserted_events_type_idinteger nullable

For upserted events, indicates whether the upsert resolved to a create or update.

timestampstring date-time

Timestamp of when the event request was recorded.

bodyobject

The original request body that was submitted with the event.

Example response

{
  "event_request_token": "EV-xi7Etep0gW7gZiuWsqXG",
  "event_type": "person_created",
  "events_api_type_id": 1,
  "event_status_id": null,
  "event_lifecycle_id": null,
  "external_event_id": "audit-event-123",
  "event_request_status_type_id": 1,
  "event_request_source": null,
  "ingestion_batch_token": null,
  "upserted_events_type_id": null,
  "timestamp": "2024-12-06T17:04:25.579Z",
  "body": {
    "event_type": "person_created",
    "data": {
      "external_entity_id": "087ac67e-17ab-4529-8d1a-a8b2214d305f",
      "name_first": "John",
      "name_last": "Smith",
      "timestamp": "2024-12-06T17:04:25.579Z"
    }
  }
}