Skip to main content
_id
string
required

An identity that is automatically generated as a technical identification of an alert.
Example: 66fb0c1d2e3f4a5b6c7d8e9f

alertCode
string
required

Kind of alert. It decides which fields data contains.
Example Options: geofence.enter, geofence.leave, idle.detected, idle.repeated, user.panic, task.lateness.predicted, route.deviation.detected, overspeed.detected, device.battery.low, driver.offline

alertName
string
required

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

title
string
required

Short title of the alert.

message
string
required

Message describing the alert.

eventTime
string
required

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

assignee
string

Email of the user the alert is about.

hubId
string | null

Unique ID to identify a hub.
Example: 6a712e4c2385f1c14e04beeb

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.