v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Notifications

Registers for notifications

User can subscribe to notifications of all events triggered by device telemetry and rules and geofences.

To get notified about some specific events only, one can set up ruleId, eventSource, eventType and initialState filters for a notification channel.

post/notifications/v3/registrations

Query parameters

projectIdstring

Project ID. Any HERE Tracking user must be a member of a Tracking project. The project ID can be implicitly resolved if the user calling the API is a member of a single project. If the user is a member of multiple projects, the projectId query parameter needs to be specified explicitly.

userIdstring

The HERE Account ID of a user.

User Id.

Request body

channelType'webhook' | 'email' | 'browserPull' required

The type of notification channel.

eventSource'attach' | 'battery' | 'geofence' | 'humidity' | 'pressure' | 'tamper' | 'temperature' | 'acceleration' | 'dwelling' | 'stock' | 'detention' | 'utilization' | 'online' | 'shipmentSchedule'

The event source rule type.

eventType'BELOW_RANGE' | 'IN_RANGE' | 'ABOVE_RANGE' | 'FALSE_TO_TRUE' | 'TRUE_TO_FALSE' | 'EVENT' | 'INSIDE_GEOFENCE' | 'OUTSIDE_GEOFENCE' | 'OVERSTOCK' | 'NORMAL_VOLUME' | 'UNDERSTOCK' | 'DWELLING_STARTED' | 'DWELLING_ENDED' | 'DETENTION_STARTED' | 'DETENTION_ENDED' | 'UTILIZED' | 'UNUTILIZED' | 'SHIPMENT_EARLY' | 'SHIPMENT_ON_TIME' | 'SHIPMENT_DELAYED'

Type of the event.

An event is created every time an associated rule or geofence is triggered by a device ingestion. The event type depends on the data the device sends.

Sensors that report numerical data (such as battery, humidity, pressure and temperature sensors), generate an event when the reported sensor reading of the device goes in or out of range, which is configured in the rule. This produces events of BELOW_RANGE, IN_RANGE and ABOVE_RANGE types.

Sensors that report boolean data (such as attach and tamper sensors), generate events when the device transitions from one state to another, either from false to true or vice versa. This produces events of FALSE_TO_TRUE and TRUE_TO_FALSE types. The same event types are also generated by the online rule when the device state changes from offline (when the device has stopped ingesting data) to online (when the device data ingestion has resumed) or vice versa.

The acceleration sensor generates events whenever the reported sensor reading crosses the acceleration threshold (for example, when the device was dropped). This produces events of the type EVENT. Such events are stateless.

Events of INSIDE_GEOFENCE and OUTSIDE_GEOFENCE types are generated when the device enters or exits a geofence associated with the device.

Events of DWELLING_STARTED type are generated when the device has stayed inside an associated geofence for longer than the threshold duration. DWELLING_ENDED type events are generated when dwelling of the device has ended.

Events of DETENTION_STARTED type are generated when the device has been stationary for longer than the threshold duration, regardless whether the device is inside or outside of any geofence. DETENTION_ENDED type events will be generated when the device starts moving again.

Events of UNUTILIZED type are generated when the device has been stationary for longer than the threshold duration. UTILIZED type events are generated when the device starts moving again after having been stationary.

Events of OVERSTOCK, NORMAL_VOLUME and UNDERSTOCK types are generated when the number of assets inside a geofence crosses the minVolume and maxVolume thresholds of an associated stock rule.

Events of SHIPMENT_EARLY, SHIPMENT_ON_TIME and SHIPMENT_DELAYED types are generated when a shipment is too early, on time or delayed.

initialStateboolean

Events with the initialState property set as true are generated when the rule is evaluated for the first time. It indicates the fact that this is the initial evaluation state, which would serve as a starting point for the subsequent rule evaluations. The rest of the rule events would represent a transition of a device or a shipment or a geofence from one state to another and their initialState property will be set to false.

ruleIdstring uuid

Must be a valid UUIDv4.

urlstring

A webhook URL that will receive notifications POST requests.

Response

Created

The notification channel for the specified user or device was successfully created