Sorry, you need to enable JavaScript to visit this website.
Geofencing API
Get your key

Create transition alert rule (Deprecated)

 

Service version: 1
Last edit: 2020.11.16

On this page

Deprecation notice

November 6, 2020:

  • The "Create transition alert rule" endpoint has been deprecated.
  • This endpoint has been replaced with the generic endpoint to handle all types of Alert Rules: Create Alert Rule.
  • This endpoint will be withdrawn following a 12 month deprecation period.
  • The planned withdrawal date is December 1, 2021.
  • Following withdrawal, requests to this endpoint may receive an HTTP 404 error in response.
  • More details are available at the TomTom deprecation policy page.

Purpose

This endpoint is used to configure a Transition Alert Rule.

Request data

HTTPS method: POST

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in normal text.
https://baseURL/geofencing/versionNumber/alerts/transitions?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -v -XPOST -H "Content-type: application/json" -d
'{
   "name": "Enter name of created alert rule",
   "object": "Enter id of watched object",
   "project": "Enter id of watched project",
   "fence": "Enter id of watched fence",
   "transitionType": "ALL",
   "notificationGroup": "Enter id of your notification group",
   "enabled": true
 }'
'https://baseURL/geofencing/versionNumber/alerts/transitions?key=Your_API_Key&adminKey=Your_Admin_Key'

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of request parameters is not important.
Required parameters
Parameter Description
baseURL
string 		The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string 		Service version.
Value: 1
key
string 		An API Key valid for the requested service.
Value: Your valid API Key.
adminKey
string 		An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.
Optional parameters
Note: There are no optional parameters in this endpoint.

POST request body

{
  "name": "Enter name of created alert rule",
  "object": "Enter id of watched object",
  "project": "Enter id of watched project",
  "fence": "Enter id of watched fence",
  "transitionType": "ALL",
  "notificationGroup": "Enter the id of your notification group",
  "enabled": true
}

Request fields

The following table describes the fields that can be used in a request body.

Primary fields
Field Description
name
string 		The name of the alert rule.
Field is not required.
Default value: empty
object
string 		The UUID of the object or * for any object in configuration.
project
string 		The UUID of the project or * for any project in configuration.
fence
string 		The UUID of the fence or * for any fence in configuration.
transitionType
string 		The type of the transition to alert.
Possible values:
  • "ENTER": When an object just entered the fence.
  • "EXIT": When an object just exited the fence.
  • "ALL": When an object just entered or exited the fence.
notificationGroup
string 		The UUID of the owned group in the Notification Service to send an alert.
enabled
boolean 		The Boolean value that says if an alert rule is enabled or not.
Values:
  • true: An alert is enabled.
  • false: An alert is disabled.
Field is not required.
Default value: true

▲ Return to top

Response data

Response body

{
  "id": "Id of created alert rule",
  "covers": ["Id of covered other alert rule", "Id of covered other different alert rule"]
}

Response fields

The following table describes all of the fields that can appear in a response.

Primary fields
Field Description
id
string 		The UUID of the alert rule.
covers[]
array 		The list of UUID alerts covered by the already created alert rules.

HTTP response codes

Code Meaning and possible causes
201 Created
400 Bad request:
  • Alert rule name is too long.
  • Object id is not provided.
  • Object id is incorrect.
  • Project id is not provided.
  • Project id is incorrect.
  • Fence id is not provided.
  • Fence id is incorrect.
  • Transition type is not provided.
  • Transition type is incorrect.
  • Notification group id is not provided.
  • Notification group id is incorrect.
403 Forbidden:
  • Provided Admin Key is invalid.
  • Admin Key is missing.

▲ Return to top

Examples

Example: Create a new transition alert rule.

Request format

https://api.tomtom.com/geofencing/1/alerts/transitions?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=b330d317-4fe1-4d48-b75f-06cc3be58fb2

POST body format

{
  "name": "Airport transition alert rule",
  "object": "*",
  "project": "ab550513-7026-4c98-9ff7-a930d70b66f8",
  "fence": "0b16633b-7b2b-4fd6-a834-f36c2250ab66",
  "transitionType": "ALL",
  "notificationGroup": "8e34613a-2324-4749-ac9d-25bf7a91d218",
  "enabled": true
}

Response body

{
  "id": "1f9e811f-867b-4d4d-aed9-7d8266fac0ae",
  "covers": ["e4f06777-079e-4f02-a49d-97dd4c4e3a81", "c930bae3-98c8-4c07-93e6-f01ca1c3134a"]
}

▲ Return to top