Product documentation

01. ZONE_EVENT

This event occurs when a zone-event is intercepted with:

  • Trackable IDs (trackablesIds)
  • Geofence IDs (geofencesList)

Basically when a trackable device enters, leaves a zone or looses contact with the system.

{
  "id": "07eebe87-cbcd-4a22-9d0d-eebbc661d3a2",
  "name": "Entering Dematching Zone",
  "description": "This event occurs when a tag enters the Dematching Zone",
  "type": "ZONE_EVENT",
  "rootVenueScopeId": "42",
  "managedZoneEventType": "ENTER",
  "trackablesIds": [
    "*"
  ],
  "geofencesList": [
    "*"
  ],
  "waitDurationInSeconds": 2,
  "customData": {
    "event_custom_data": "event_custom_value"
  },
  "stopRoutinesExecutionOnError": false
}
FieldDescriptionPossible values for ZONE_EVENT
nameThe name of the event.Any text (has to be unique)
For example:
  • “Entering Dematching Zone”
  • “Asset deleted”
  • “Ping me button clicked”
descriptionThe description of the event.Any text.
For example:
  • “This event occurs when a tag enters the Dematching Zone.”
  • “This event happens when an asset is deleted (when a tag and an asset are being dematched).”
typeThe type of the event.ZONE_EVENT
rootVenueScopeIdDelivered by Favendo. This is the ID of the venue.A specific integer
managedZoneEventTypeOnly needed when the type “ZONE_EVENT” is selected.
  • ENTER
  • EXIT
trackablesIdsThe IDs of the trackable devices the event should apply to.
  • “*”: The event applies to all trackable IDs
  • Or comma separated trackable IDs (for example “ca0400069993″,”8cf681aa1b94″,”8cf681c40a9b”)
geofencesListThe zones/geofences for which the zone event applies.
Only needed when the type “ZONE_EVENT” is selected.
  • “*”: The event applies to all geofences
  • Or comma separated geofences
waitDurationInSecondsThis is the duration in seconds that the system will wait before triggering the routine based on this event.Any integer
customDataThe data in customData can be retrieved by the routines.“customData”: { “event_custom_data”: “event_custom_value” }
matchKeyN.A.N.A.
stopRoutinesExecutionOnErrorIf set to true, in case a routine encounters an error, the remaining routines will not be executed.
  • false (default)
  • true