Sorry, you need to enable JavaScript to visit this website.

Alert service

 

Service version: 1
Last edit: 2020.09.30

Purpose

The Geofencing API Alert service is responsible for creating alert messages which will be sent to users via the Notifications API. The Alert service allows the set up alerts for:

  • The Transition between an Object and a Fence.
  • An Object exceeding the set time limit for dwelling inside a Fence.
  • Number of Objects inside a Fence has exceeded the set limit.

Alert service generic endpoints (recommended)

We highly recommend using these generic endpoints to handle all types of alert rules.

The Alert service contains the following endpoints:

POST Create alert rule
This endpoint is used to configure an Alert Rule.
GET Get alert rule
This endpoint is used to show details of the Alert Rule.
GET List alert rules
This endpoint is used to list Alert Rules.
PATCH Update alert rule partially
This endpoint is used to update selected fields of an Alert Rule.
DELETE Delete alert rule
This endpoint is used to delete an Alert Rule.
GET List alert history
This endpoint is used to list Alerts that were triggered in a given time period.
DELETE Delete alert history
This endpoint is used to clear all Alert History entries.

Please use the navigation menu on the left-side of each page to find the topic and data you need.

Alert service endpoints for Transition Alerts

The Alert service contains the following endpoints:

POST Create transition alert rule
This endpoint is used to configure a Transition Alert Rule.
GET Get transition alert rule
This endpoint is used to show details of the Transition Alert Rule.
GET List transition alert rules
This endpoint is used to list Transition Alert Rules.
PATCH Update transition alert rule partially
This endpoint is used to update selected fields of a Transition Alert Rule.
DELETE Delete transition alert rule
This endpoint is used to delete a Transition Alert Rule.
GET List transition alert history
This endpoint is used to list Transition Alerts that were triggered in a given time period.
DELETE Delete transition alert history
This endpoint is used to clear all Transition Alert History entries.

Please use the navigation menu on the left-side of each page to find the topic and data you need.

Alert service endpoints for Dwell Time Alerts

The Alert service contains the following endpoints:

POST Create dwell time alert rule
This endpoint is used to configure a Dwell Time Alert Rule.
GET Get dwell time alert rule
This endpoint is used to show details of the Dwell Time Alert Rule.
GET List dwell time alert rules
This endpoint is used to list Dwell Time Alert Rules.
PATCH Update dwell time alert rule partially
This endpoint is used to update selected fields of a Dwell Time Alert Rule.
DELETE Delete dwell time alert rule
This endpoint is used to delete a Dwell Time Alert Rule.
GET List dwell time alert history
This endpoint is used to list Dwell Time Alerts that were triggered in a given time period.
DELETE Delete dwell time alert history
This endpoint is used to clear all Dwell Time Alert History entries.

Please use the navigation menu on the left-side of each page to find the topic and data you need.

▲ Return to top