Product documentation

02. USER_TRIGGERED_EVENT

This event occurs when a non geofence based event is intercepted with:

  • Trackable IDs (trackablesIds)
  • matchKey (matchKey)

It can be for example when a dematch between assets and tags happens or a button is clicked on a frontend.

{
  "id": "07eebe87-cbcd-4a22-9d0d-eebbc661d3a2",
  "name": "Asset deleted",
  "description": "This event occurs when an asset is deleted (when a tag and an asset are dematched).",
  "type": "USER_TRIGGERED_EVENT",
  "rootVenueScopeId": "42",
  "trackablesIds": [
    "*"
  ],
  "waitDurationInSeconds": 2,
  "customData": {
    "event_custom_data": "event_custom_value"
  },
  "matchKey": "DELETED_ASSET_EVENT",
  "stopRoutinesExecutionOnError": false
}
FieldDescriptionPossible values
nameThe name of the event.Any text (has to be unique)
For example: “Ping me button clicked”
descriptionThe description of the event.Any text.
For example:
  • “This event happens when an asset is deleted (when a tag and an asset are being dematched).”
typeThe type of the event.USER_TRIGGERED_EVENT
rootVenueScopeIdDelivered by Favendo. This is the ID of the venue.A specific integer
managedZoneEventTypeN.A.N.A.
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”)
geofencesListN.A.N.A.
waitDurationInSecondsThis is the duration in seconds that the system will wait before triggering the routine based on this event.N.A.
customDataThe data in customData can be retrieved by the routines.“customData”: { “event_custom_data”: “event_custom_value” }
matchKeyOnly needed when the type “USER_TRIGGERED_EVENT” is selected.
  • null: events with empty “matchKey” will be managed
  • Or comma separated matchKeys: only the events with same match key will be managed
stopRoutinesExecutionOnErrorIf set to true, in case a routine encounters an error, the remaining routines will not be executed.
  • false (default)
  • true