Skip to main content

An event raised while monitoring field users, returned by GET /alerts. Fields shared by every alert are at the top level, including the required title and message. Fields specific to one kind of alert are inside data, which is returned exactly as stored: its keys depend on alertCode (pick a tab under data to see each kind), it is always an object ({} when the alert stores nothing), and an alert recorded by an older version may carry keys that are no longer written (for example title, message, titleKey or messageParams). The position (lat, lon) is inside data because some kinds of alert have none; alerts recorded before this change are returned without a position.

title
string
required

Short title of the alert.

message
string
required

Message describing the alert.

_id
string

Unique identifier of the alert.

alertCode
enum<string>

Kind of alert. It decides which fields data contains.

Available options:
geofence.enter,
geofence.leave,
idle.detected,
idle.repeated,
user.panic,
task.lateness.predicted,
route.deviation.detected
alertName
string

Readable name of the alert kind, for example Left geofence.

assignee
string

Email of the user the alert is about.

eventTime
string

When the event happened (ISO 8601), not when the alert was stored.

data
Geofence enter · object

Returned when alertCode is geofence.enter.

isResolved
boolean

Whether the alert has been resolved.

resolvedTime
string | null

When the alert was resolved (ISO 8601). null while unresolved.

resolvedBy
string | null

Email of the user who resolved the alert.

resolvedByName
string | null

Name of the user who resolved the alert.

resolvedNotes
string | null

Notes written when the alert was resolved.