v1

latestOpenAPI 3.1.02026-08-06230114.0 KB
Application Geo-Zones

Create an Application Geo-Zone

post/v1/application-geozones/

Headers

Authorizationstring

User access token

User access token

Content-Type'application/json'

Request body

eventsstring[] required

Events that will trigger a webhook

imeistring required

IMEI of the device that will trigger the webhook

locationIdstring required

Unique identifier of the location to alert on. See Create a Location

scheduleIdstring

Unique identifier of the schedule for when the geozone is active. See Create a Schedule

Example request

{
  "events": [
    "ENTER",
    "EXIT"
  ],
  "imei": "123456789012345",
  "locationId": "65f8a2b4c9d7e1234567890e",
  "scheduleId": "65f8a2b4c9d7e1234567890f"
}

Response

Returns the created application geozone

idstring required

Unique identifier

imeistring required

IMEI of the device that will trigger the webhook

eventsstring[] required

Events that will trigger a webhook

locationIdstring required

Unique identifier of the location to alert on

scheduleIdstring

Unique identifier of the schedule for when the geozone is active

Example response

{
  "id": "65f8a2b4c9d7e1234567890a",
  "imei": "123456789012345",
  "events": [
    "ENTER",
    "EXIT"
  ],
  "locationId": "65f8a2b4c9d7e1234567890e",
  "scheduleId": "65f8a2b4c9d7e1234567890f"
}