04. NOTIFICATION – Favendo Documentation

This routine sends a notification through MQTT using the following routing key `f.z.e.*.fav.notifENUW_SCOPE_ID.TARGET`.

{
  "name": "notification",
  "rootVenueScopeId": "999",
  "description": "notification",
  "routineType": "NOTIFICATION",
  "title": "title {{trackableId}}",
  "text": "text {{trackableId}}",
  "priority": 1,
  "targetList": ["VIEWER"],
  "executionOrder": 3,
  "durationInSeconds": 10,
  "conditionalExpression":"assignedAssetDto!=null"
}

Field	Description	Possible values
name	The name of the routine.	Any text (has to be unique) For example: “Notification”
description	The description of the routine.	Any text. For example: “This routine sends a notification to the Viewer.”
rootVenueScopeId	Delivered by Favendo. This is the ID of the venue.	A specific integer
routineType	The type of the routine.	NOTIFICATION
body	Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected.	N.A.
requestUrl	Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected.	N.A.
httpMethod	Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected.	N.A.
httpHeaders	Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected.	N.A.
Title	Only needed when the routineType “NOTIFICATION” is selected.	Any text. This is the title of the notification, that the users will see.
Text	Only needed when the routineType “NOTIFICATION” is selected.	Any text. This is the text of the notification, that the users will see.
Priority	Only needed when the routineType “NOTIFICATION” is selected.	Integer from 1 to 5. 5 being the highest priority.
targetList	Only needed when the routineType “NOTIFICATION” is selected.	[“VIEWER”] [“TAGGER”] [“VIEWER”,”TAGGER”] This is where the notification will be shown to the users.
durationInSeconds	Only needed when the routineType “NOTIFICATION” is selected.	Describes the duration in seconds of the notification. default value is 0
executionOrder	Describes the order of the routines executions in case a managed event has more than one routine assigned.	Integer
conditionalExpression	Condition that needs to be met in order for the routine to be executed. It is expressed in SpEL, and it always needs to return a boolean value. The expression can also reference properties from the triggered event. If the field is empty, the routine is always executed (defaults to true). For SpEL docs see https://docs.spring.io/spring-framework/docs/4.1.x/spring-framework-reference/html/expressions.html	Spring expression language. See 04. Spring expression language for more information.