Authentication
API key or session token with theevents:read permission. API keys have it. An API key reads only events of its own environment. A session reads production events unless it passes environment=sandbox.
Path parameters
string
required
Event ID (UUID) returned when the event was created.
Query parameters
string
Sessions only:
production (default) or sandbox.Example
Response
200 OK
string
Event ID (UUID). Same value as
event_id in the other event endpoints.string
Your tenant ID.
string | null
Internal ID (UUID) of the event’s zone. Use
zone_code to match your own zone codes.string | null
Zone code, the value you send as
metadata.zone_id.string | null
Zone name.
string
The key the event was created with.
string
Event type as sent.
string | null
ID of the type in your catalog (see
GET /v1/catalog). null for an event sent before 8 October 2026 with a type that is not in your catalog.boolean
true when the type sends a field team. dispatchable carries the same value and is kept for clients of SDK 2.4.1.string
Vertical.
string
low, normal, high or critical.string
pending, completed or failed. See below.string | null
Delivery channel. See below.
string
production or sandbox.object
Your payload. For a type that does not send a team it is emptied (
{}) once a channel has confirmed delivery. For a type that sends a team (requires_teams) it is kept until the event is closed or its missions end, so the teams have the data they are sent for. A field_operator session receives a reduced payload, see below.object
Labels of the
payload fields written by your parser, keyed by field name: { "incident_type": { "label": "Incident type", "value_label": "Cardiac arrest" } }. value_label is present for enumerated fields and gives the label of the chosen option; the codes in payload never change. Absent when the event has no parser, or when no key of the payload is a parser field. The same object comes with the event.created webhook.object
The metadata sent with the event, or
{}.boolean
Only for a
field_operator session: true, the payload and metadata were reduced to what the team may see.string
Only for a
field_operator session: no_parser when the event’s vertical has no parser, so no field was marked for the team and the payload is withheld.string | null
Connectivity at capture time, for synced events that sent it.
string | null
Integrity checksum, for synced events.
string | null
Reserved. The
sdk_version you send is kept in metadata.string | null
Reserved. The
operator_id you send is kept in metadata.string | null
Reserved for dispatch. You can ignore it.
string | null
Reserved for billing. You can ignore it.
string | null
Reserved for billing. You can ignore it.
string
When wede received the event.
string
Last change.
object[]
Every step of the event, oldest first.
payload, metadata or type.
What a field operator sees
People on the ground are informed within the limits your organisation set. A session with thefield_operator role receives the event with:
payloadreduced to the fields marked Show to team in the parser the event was written with (metadata.parser), or, for an event sent over the API, in the active parser model of its vertical whose type field maps to the event type. Keys outside the parser never reach the team. With no parser for the vertical,payloadis{}andfilter_reasonisno_parser; the dashboard warns the company admin until a parser is active.metadatareduced tozone_id,location,parser,offline_generated_atandconnectivity_state_at_generation.labelsfor the fields it sees,payload_filtered: true, and everything else unchanged: type, category, priority, status, channel, location and lifecycle.
Status and channel
The status is the delivery status. Missions of the optional teams module never change it: follow a mission’s outcome on the mission itself.
When an event of a type that does not send a team becomes
completed, wede clears the stored payload and keeps the identifiers, type, channel and lifecycle. An event of a type that sends a team keeps its payload until it is closed (by an operator, or when its primary mission completes) or until its last active mission completes; then the payload is cleared too.
