Rule Engine Events
Contents |
Custom
The event will trigger only if the name and all the key-value options match the correspondent parameters provided in the API call.
event_type | required | Value: custom |
---|---|---|
event_attrs | required | A hash in the format field:value. |
name | required | The name of the custom event |
options | optional | A hash in the format field:value. |
Aruba ALE
Geofence Notify
This event will trigger when a user enters ("in") or exits ("out") the specified geofence region.
event_type | required | Value: aruba_ale_geofence_notify |
---|---|---|
event_attrs | required | A hash in the format field:value. |
geofence_event | required | Allowed values: in, out |
geofence_name | required | The name of the geofence region. |
Presence
This event will trigger while a user is in the coverage area1.
event_type | required | Value: aruba_ale_presence |
---|---|---|
event_attrs | optional | No attribute required. |
Cisco Meraki
Devices Seen
This event will trigger while a user is in the coverage area1.
event_type | required | Value: cisco_cmx_devices_seen |
---|---|---|
event_attrs | optional | A hash in the format field:value. |
tags | optional | A comma separated list of tags to match. |
floors | optional | A comma separated list of floors to match. |
Zebra ADSP
Presence Entered
This event will trigger when a user enters the coverage area.
event_type | required | Value: presence_entered |
---|---|---|
event_attrs | optional | No attribute required. |
Presence Exit
This event will trigger when a user exits the coverage area.
event_type | required | Value: presence_exit |
---|---|---|
event_attrs | optional | No attribute required. |
Presence Present
This event will trigger while a user is in the coverage area1.
event_type | required | Value: presence_present |
---|---|---|
event_attrs | optional | No attribute required. |
Region Entered
This event will trigger when a user enters the specified region.
event_type | required | Value: region_entered |
---|---|---|
event_attrs | required | A hash in the format field:value. |
region_name | required | The name of the region. |
Region Exit
This event will trigger when a user exits the specified region.
event_type | required | Value: region_exit |
---|---|---|
event_attrs | required | A hash in the format field:value. |
region_name | required | The name of the region. |
Region Near
This event will trigger while a user is within a proximity of the specified region1.
event_type | required | Value: region_near |
---|---|---|
event_attrs | required | A hash in the format field:value. |
region_name | required | The name of the region. |
Region Present
This event will trigger while a user is in the specified region1.
event_type | required | Value: region_present |
---|---|---|
event_attrs | required | A hash in the format field:value. |
region_name | required | The name of the region. |
Zebra MPact
Dwell Time
This event will trigger while a user is in the specified region1.
event_type | required | Value: dwell_time |
---|---|---|
event_attrs | required | A hash in the format field:value. |
notification_name | required | The name of the notification. |
Entry
This event will trigger when a user enters the coverage area.
event_type | required | Value: entry |
---|---|---|
event_attrs | required | A hash in the format field:value. |
notification_name | required | The name of the notification. |
Notes
1 Presence events will continuously trigger (e.g. every minute) for the same users while they are in the location. When configuring a rule, make use of Policies to avoid sending unnecessary or repeated messages.