Rule types
Rule types with all parameters to create. The rule availability depends on the device and rule integration for it.
Common parameters
Common parameters exist in all rule types.
name | description | type |
description | Rule's description. | string |
primary_text | Primary text of rule notification. | string |
alerts | Alerts object with destinations for notifications. Described in rule_object. | JSON object |
suspended | true if the rule suspended. | boolean |
name | Name of a rule. | string |
trackers | List of bound tracker IDs. | int array |
extended_params | Extended parameters for the rule. Described below. | JSON object |
schedule | The rule will work in specified period. Described in rule_object. | JSON object |
zone_ids | List of bound zones. | int array |
Common extended parameters
extended_parameters
that used in all rule types.
name | description | type |
emergency | If true enables emergency notification. | boolean |
zone_limit_inverted | The rule tracked inside or outside zones. Default is: false . | boolean |
private_rule | Affects only sub users now. If true then the rule and notifications are visible only to sub user. | boolean |
Geofence entrance or exit
A rule that triggers on entering/exiting geofences.
parameters
name | description | type |
type | Default type : "inoutzone". | enum |
secondary_text | Secondary text of rule notification. | string |
extended parameters
name | description | type |
append_zone_title | Show or not a label of zone in a notification. | boolean |
Speed exceeding
A rule that triggers on speed exceeding.
parameters
name | description | type |
type | Default type : "speedup". | enum |
param | Speed limit. | int |
Parking state detection
A rule that triggers on detection of parking state.
parameters
name | description | type |
type | Default type : "track_change". | enum |
secondary_text | Secondary text of rule notification. | string |
Deviation from the route
A rule that triggers on deviations from the route.
parameters
name | description | type |
type | Default type : "route". | enum |
extended parameters
name | description | type |
allow_exit_at_endpoints | If true disables notifications on deviations from the start and end points of a route. | boolean |
Work status change
A rule that triggers on status changing.
parameters
name | description | type |
type | Default type : "work_status_change". | enum |
extended parameters
name | description | type |
status_ids | List of tracked status IDs. | int array |
A rule that triggers on task status changes.
parameters
name | description | type |
type | Default type : "task_status_change". | enum |
extended parameters
name | description | type |
statuses | List of tracked statuses. Possible statuses are "arrived", "done","delayed", "failed". | string array |
on_form_submission | If true form submission will track. | boolean |
on_repeated_form_submission | If true form resubmission will track. | boolean |
A rule that triggers on excessive idling registered by hardware.
parameters
name | description | type |
type | Default type : "idling". | enum |
secondary_text | Secondary text of rule notification. | string |
A rule that triggers on excessive idling registered by the platform.
parameters
name | description | type |
type | Default type : "idling_soft". | enum |
secondary_text | Secondary text of rule notification. | string |
param | Idle duration to send notification. | int |
Fuel level change
A rule that triggers on a fuel level change.
parameters
name | description | type |
type | Default type : "fuel_level_leap". | enum |
secondary_text | Secondary text of rule notification. | string |
extended parameters
name | description | type |
sensor_id | ID of tracked sensor. | int |
Harsh driving
A rule that triggers on harsh driving.
parameters
name | description | type |
type | Default type : "harsh_driving". | enum |
A rule that triggers on SOS button pressing.
parameters
name | description | type |
type | Default type : "sos". | enum |
Auto geofencing
A rule that triggers on auto geofencing.
parameters
name | description | type |
type | Default type : "auto_geofence". | enum |
Fall detection
A rule that triggers on fall detection.
parameters
name | description | type |
type | Default type : "g_sensor". | enum |
Unauthorized movement
A rule that triggers on unauthorized movement.
parameters
name | description | type |
type | Default type : "parking". | enum |
Car crash
A rule that triggers on a car crash.
parameters
name | description | type |
type | Default type : "crash_alarm". | enum |
Autocontrol related tracked rules.
parameters
name | description | type |
type | Default type : "autocontrol". | enum |
extended parameters
name | description | type |
alarmcontrol | Activation of car alarms. Described below | JSON object |
battery_off | Disabling of external power supply. Described below | JSON object |
door_alarm | Opening doors/trunk. Described below | JSON object |
hood_alarm | Opening hood. Described below | JSON object |
ignition | Ignition. Described below | JSON object |
parking | Unauthorized movement. Described below | JSON object |
gsm_damp | GSM-signal dumping (low signal level). Described below | JSON object |
security_control | Switching ON/OFF security mode. Described below | JSON object |
Map of sub-rules settings
{
"alarmcontrol": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true,
"always_notify": false
},
"battery_off": {
"enabled": true,
"sms": true,
"call": false,
"email": true,
"push": true
},
"door_alarm": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"hood_alarm": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"ignition": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"parking": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"gsm_damp": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"security_control": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
}
}
Advanced driver assistance systems (ADAS)
A rule that triggers on warnings from driver-assistance systems (ADAS).
parameters
name | description | type |
type | Default type : "driver_assistance". | enum |
extended parameters
name | description | type |
lane_departure_enabled | If true lane departure tracked. | boolean |
forward_collision_enabled | If true lane departure tracked. | boolean |
headway_warning_enabled | If true lane departure tracked. | boolean |
peds_in_danger_zone_enabled | If true lane departure tracked. | boolean |
peds_collision_warning_enabled | If true lane departure tracked. | boolean |
traffic_sign_recognition_enabled | If true lane departure tracked. | boolean |
A rule that triggers on a driver identification.
parameters
name | description | type |
type | Default type : "driver_identification". | enum |
secondary_text | Secondary text of rule notification. | string |
Driver change
A rule that triggers on driver change.
parameters
name | description | type |
type | Default type : "driver_change". | enum |
Fatigue driving
A rule that triggers on fatigue driving.
parameters
name | description | type |
type | Default type : "fatigue_driving". | enum |
Social distancing monitoring
A rule that triggers on social distancing violation.
parameters
name | description | type |
type | Default type : "proximity_violation". | enum |
secondary_text | Secondary text of rule notification. | string |
Tracker switched OFF or lost connection
A rule that triggers on device switch OFF and lost connection.
parameters
name | description | type |
type | Default type : "offline". | enum |
secondary_text | Secondary text of rule notification. | string |
param | Offline time to notification. | int |
GSM signal dump
A rule that triggers on GSM signal dump.
parameters
name | description | type |
type | Default type : "gsm_damp". | enum |
Low battery
A rule that triggers on low internal battery.
parameters
name | description | type |
type | Default type : "lowpower". | enum |
Bracelet sensor
A rule that triggers on bracelet sensor opening/closing.
parameters
name | description | type |
type | Default type : "bracelet". | enum |
Car alarm triggered
A rule that triggers on car alarm.
parameters
name | description | type |
type | Default type : "alarmcontrol". | enum |
Tracker detach from the objects
A rule that triggers on a tracker detach from the object.
parameters
name | description | type |
type | Default type : "detach". | enum |
External power cut
A rule that triggers on external power cut.
parameters
name | description | type |
type | Default type : "battery_off". | enum |
secondary_text | Secondary text of rule notification. | string |
Door opening in alarm mode
A rule that triggers on door opening in alarm mode.
parameters
name | description | type |
type | Default type : "door_alarm". | enum |
Hood opening in alarm mode
A rule that triggers on hood opening in alarm mode.
parameters
name | description | type |
type | Default type : "hood_alarm". | enum |
Location report on demand
A rule that triggers on location requests.
parameters
name | description | type |
type | Default type : "location_response". | enum |
Connection/disconnection to the OBD2 port
A rule that triggers on connection/disconnection to the OBD2 port.
parameters
name | description | type |
type | Default type : "obd_plug_unplug". | enum |
secondary_text | Secondary text of rule notification. | string |
Tracker switch ON/OFF
A rule that triggers on tracker switch ON/OFF.
parameters
name | description | type |
type | Default type : "on_off". | enum |
secondary_text | Secondary text of rule notification. | string |
Locking/unlocking (padlock)
A rule that triggers on locking/unlocking(padlock).
parameters
name | description | type |
type | Default type : "locking_unlocking". | enum |
secondary_text | Secondary text of rule notification. | string |
Backup battery low
A rule that triggers on backup battery low.
parameters
name | description | type |
type | Default type : "backup_battery_low". | enum |
Case intrusion
A rule that triggers on case intrusion.
parameters
name | description | type |
type | Default type : "case_intrusion". | enum |
GPS signal lost/recover
A rule that triggers on GPS signal lost/recover.
parameters
name | description | type |
type | Default type : "gps_lost_recover". | enum |
secondary_text | Secondary text of rule notification. | string |
Padlock tampering
A rule that triggers on padlock tampering.
parameters
name | description | type |
type | Default type : "strap_bolt". | enum |
secondary_text | Secondary text of rule notification. | string |
Vibration sensor
A rule that triggers on vibration sensor.
parameters
name | description | type |
type | Default type : "vibration". | enum |
secondary_text | Secondary text of rule notification. | string |
Light sensor
A rule that triggers on a light sensor.
parameters
name | description | type |
type | Default type : "light_sensor". | enum |
secondary_text | Secondary text of rule notification. | string |
A rule that triggers on call button pressing.
parameters
name | description | type |
type | Default type : "call_button_pressed". | enum |
Tracker switched ON
A rule that triggers on tracker switch ON.
parameters
name | description | type |
type | Default type : "poweron". | enum |
GPS antenna disconnected
A rule that triggers on GPS antenna disconnect.
parameters
name | description | type |
type | Default type : "antenna_disconnect". | enum |
Check engine (MIL)
A rule that triggers on check engine (MIL) events.
parameters
name | description | type |
type | Default type : "check_engine_light". | enum |
A rule on inputs triggering.
parameters
name | description | type |
type | Default type : "input_change". | enum |
secondary_text | Secondary text of rule notification. | string |
param | Input number. | int |
Outputs triggering
A rule on outputs triggering.
parameters
name | description | type |
type | Default type : "output_change". | enum |
secondary_text | Secondary text of rule notification. | string |
param | Output number. | int |
Parameter in range
A rule that triggers on a parameter in range.
parameters
name | description | type |
type | Default type : "sensor_range". | enum |
secondary_text | Secondary text of rule notification. | string |
extended parameters
name | description | type |
threshold | A threshold for a sensor. | int |
sensor_id | ID of a tracked sensor. | int |
min | A minimum range value. | int |
max | A maximum range value. | int |
No movement
A rule that triggers when the device is stationary.
parameters
name | description | type |
type | Default type : "no_movement". | enum |
Distance between objects
A rule that triggers a change in distance between objects. The distance is measured by the last valid GPS coordinates.
parameters
name | description | type |
type | Default type : "distance_control". | enum |
secondary_text | Secondary text of rule notification, when distance is restored. | string |
extended parameters
name | description | type |
observed_trackers | List of observed tracker IDs. | int array |
control_type | Type of distance control. One of ["moving_away", "approaching"] . | enum |
control_distance_meters | Distance for control in meters. | int |
Last update: December 26, 2022