Triggers
Overview
Triggers are used to monitor a single status of a device.
For example, this can be a GPI (General Purpose Input), the power supply state, the temperature of the unit or even bandwidth measurements on a switch.
The trigger reacts to the configured value and informs the event about its current status.
Base Parameters
Each trigger has the following base parameters:
Parameter | Description |
---|---|
Name | Name to identify this model |
Enabled | Indicates if the model is enabled |
Trigger Type | Type to decide which parameters are needed |
Device | The associated device |
Category | The associated category |
Description | Additional description |
Initial Status | Status which is used after initialization |
Logging | If enabled, this item will create log entries |
Last State | The last TriggerState |
Occurrences | Number of times this item has occurred |
Pulse | If enabled, this Trigger automatically returns to the status Off after the configured time in the PulseDuration |
Pulse Duration | Duration after this Trigger returns to the status Off, if Pulse is enabled. The default value can be changed globally in the settings In milliseconds |
Restore State on Init | Set true , to restore the StatusState (from LastState) during initialization |
Sequence Number | The unique sequence ID of this item. Used for the Ember+ provider OID. |
Status Code | The current status code |
Status Message | The current status message |
Status | The current status |
Substitution Table | The associated Substitution Table |
Switch-off time | The switch-off time defines how long a measurement value needs to mismatch the trigger configuration before it changes its status to Off |
Switch-on time | The switch-on time defines how long a measurement value needs to match or exceed the defined threshold or value before it changes its status to On |
Toggle | When enabled, the Trigger status is switched between On and Off each time the Trigger condition is met. |
Bionic Studio GPIO
Listens for GPOs sent by Broadcast Bionics's (http://www.phonebox.com)
Parameter | Description |
---|---|
Listen Port | Must match the Bionic Studio configuration |
GPO Number | PhoneBox GPO Number |
GPO Value | Expected GPO Value |
The following GPO Values
are currently supported:
- True
- False
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{ConditionFulfilled} | 1 if Trigger condition is fulfilled, 0 otherwise |
Bionic Studio Status
Parameter | Description |
---|---|
Command | |
Item Name / ID | |
Polling Interval | In seconds |
The following Commands
are currently supported:
- Client Status
- Extension Availability
- Extension In Use
- Service Registration
- Trunk out of Service
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{ExpectedProperty} | |
{RequestUri} | |
{Response} |
Blackmagic ATEM Tally
Listens and reacts to inputs of Blackmagic Design ATEM switchers.
Parameter | Description |
---|---|
Input | As shown in the ATEM Remote Software |
Type | Expected input state |
Only available on Windows installations.
The following Types
are currently supported:
- Preview
- Program
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{InputId} | |
{InputLongName} | |
{InputShortName} | |
{ProductName} |
Codec Control
Parameter | Description |
---|---|
Expected Codec Status |
The following Codec Status
are currently supported:
- Calling
- Connecting
- Disconnecting
- Failed
- Framed
- Idle
- Not Ready
- Reserved
- Ringing
- Timeout
- Unknown
Cron
Uses so-called cron expressions to change the status of the trigger to On periodically.
This is useful for configurations where specific actions should be executed regularly, e.g., every hour or every first Monday of the month.
You can create your cron expression on http://www.cronmaker.com
Parameter | Description |
---|---|
Cron Expression | Defines the intermittency in which the trigger becomes the status On Please refer to the manual or cronmaker.com for the detailed syntax |
Duration | Duration the trigger keeps the statusOn In seconds |
On Value | Leave empty for default value (On = 1) |
Off Value | Leave empty for default value (Off = 0) |
Default Value | Leave empty to use the Off Value |
Cron expressions are made up of seven sub-expressions, that describe individual details of the schedule. These sub-expressions are separated with white-space, and represent:
- Seconds
- Minutes
- Hours
- Day-of-Month
- Month
- Day-of-Week
- Year (optional field)
An example of a complete cron-expression is the following string:
0 0 11 ? * MON
which means “every Monday at 11:00:00 pm”.
These expressions can be generated quite easily with services like http://www.cronmaker.com.
Device Status
Parameter | Description |
---|---|
Expected Device Status |
The following Device Status
are currently supported:
- Connecting
- Connected
- Connection failed
- Disconnecting
- Disconnected
DHD Logic State
Allow to monitor the state of DHD logic elements via the ECP protocol
Parameter | Description |
---|---|
Logic ID | ID of the DHD logic element Can be found in DHD ToolBox |
Expected Logic State |
The following Logic States
are currently supported:
- True
- False
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{LogicId} | From the trigger configuration |
Disk Usage
Allows monitoring the free storage space of a volume.
Parameter | Description |
---|---|
Volume | The volume to inspect C:\ or /dev/vda1 |
Threshold | If the free disk space is less than or equal to this value, the trigger will switch to On In % |
If the monitored volume is not found, the trigger will switch to On.
The Disk Usage trigger does not count towards the license limit.
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{CurrentValue} | Free space on volume in % |
{Volume} | The inspected volume |
{TotalSize} | Volume total size with unit |
{ThresholdInPercent} | The configured threshold in % |
{FreeSpace} | Free space on volume with unit |
{FreeSpaceInPercent} | Free space on volume in % |
{UsedSpace} | Used space on volume with unit |
{UsedSpaceInPercent} | Used space on volume in % |
DMS
Make use of the Digital Metering System protocol from
DSA Volgmann and can be used to receive so-called MF-Key
values from Lawo Radio Console devices.
Parameter | Description |
---|---|
Type | |
Slot | 0 = Any (reacts to any value) |
Key | 0 = Any (reacts to any value) |
Color | |
Blink | |
Dim |
The MF-Key
value must have a length of eight characters and has the following format:
79D20100
This value translates to MF-LED 1
in Slot 2
The following Types
are currently supported:
- Screen Button
- Screen Button RGB
- Surface Button
The following Colors
are currently supported:
- Any
- Blue
- Cyan
- Green
- Magenta
- Off
- On (Any Color)
- Red
- White
- Yellow
The following Blinks
are currently supported:
- Ignore
- Off
- On
The following Dims
are currently supported:
- Ignore
- Off
- On
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Blink} | |
{Color} | |
{Dim} | |
{Key} | |
{Label1} | |
{Label2} | |
{MessageId} | |
{Slot} |
Dummy
Has always a defined status and can be used in Events, Panels and other places where a defined output state is required
Parameter | Description |
---|---|
Default Status | Does always keep this status |
Value |
The following Default Status
are currently supported:
- No State
- Off
- On
- Failed
- Initialized
- Not Initialized
- Initialization failed
- Disabled
- Paused
- Locked
- Connecting
- Connected
- Connection failed
- Timeout
- Disconnecting
- Disconnected
- Not executed
- Execution successful
- Execution failed
- Partially executed
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{DefaultStatus} |
Ember+ Consumer
Can be used with virtually any Ember+ provider to monitor a specific value within an Ember+ tree.
For more information on Ember+, please see http://www.github.com/lawo/ember-plus.
Parameter | Description |
---|---|
Ember+ Path | Path to property as shown in Ember+ Viewer The path to the parameter, e.g. /Root/Input 1/Gain |
Expected Value | |
Parameter OID | Object Identifier (OID) of parameter. Will be populated automatically if field is left empty. |
RegEx Filter | RegEx expression, which is applied on Expected Value |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{EmberPlusOid} | |
{OriginalValue} |
Ember+ GPIO
Reacts to changes of Ember+ GPIO nodes of a Lawo Radio Console device.
Parameter | Description |
---|---|
GPIO Node Name | Name of the Ember+ GPIO element as shown in TinyEmber or Lawo configuration |
GPO Number | GPO Output Number |
GPO Value | |
Parameter OID | Object Identifier (OID) of parameter. Will be populated automatically if field is left empty. |
The following GPO Values
are currently supported:
- True
- False
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{EmberPlusOid} | |
{GpioNumber} |
Ember+ Matrix
Reacts to changes of Ember+ matrices.
Parameter | Description |
---|---|
Matrix Path | Path of the Ember+ matrix node as shown in the Ember+ Viewer |
Source ID | Multiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10). Leave empty if you enable Any Source . |
Accept any source | If enabled, any source routed to the configured destination(s) will invoke this trigger. |
Destination ID | Multiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10) |
Parameter OID | Object Identifier (OID) of parameter. Will be populated automatically if field is left empty. |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Destination} | Destination ID |
{Source} | Source ID |
Ember+ Provider
Each instance is an Ember+ provider and publishes the status of all Triggers, Events and Actions within its tree. By configuring Ember+ Provider triggers, the value of the trigger values can be changed by an external Ember+ consumer.
Parameter | Description |
---|---|
Expected Value |
File
Allows you to read a file in a regular interval and compare its content with the expected value.
Parameter | Description | Supports Placeholders |
---|---|---|
File Path | Full path to the file, including the filename. Supports static placeholders. | ✔️ |
Polling Interval | In seconds | |
Read Mode | ||
Expected Value | Expected file content |
The read mode All Lines
is limited to 8 kB.
This limit can be changed in the File Trigger Max File Size in the Trigger settings.
The following Read Modes
are currently supported:
- First Line
- Last Line
- All Lines
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{FullPath} |
G&D KVM Crosspoint
Reacts to changes on Guntermann & Drunck KVM matrix devices
Parameter | Description |
---|---|
Source | Console Name |
Accept any Source | If enabled, any source routed to the configured destination will invoke this trigger |
Source Condition | Only sources where the names match the expression are processed RegEx expression |
Destination | CPU (Destination) |
Accept any Destination | If enabled, any destination will invoke this trigger |
Destination Condition | Only destinations where the names match the expression are processed RegEx expression |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Destination} | Destination Name (CPU) |
{Source} | Source Name (Console) |
HTTP Polling
External JSON APIs can be polled regularly in order to
retrieve values from other devices, external systems or web services.
If multiple HTTP Polling triggers with the same request URI are assigned to
the same node, they are automatically being grouped by polling interval and only
one request is being made. This reduces the number of requests to the remote service.
Parameter | Description | Supports Placeholders |
---|---|---|
Request URI | URI which is being called Will be combined with the device hostname if it does not start with http . Supports system, static and dynamic placeholders. | ✔️ |
Request Type | ||
Content Type | ||
Payload | Supports system, static and dynamic placeholders. | ✔️ |
Message Filter | Filter for incoming messages. The filter is applied before the trigger condition is verified. Supports JSONPath | |
Expected Property | The property which is being monitored. Supports JSONPath / XPath | |
Expected Value | ||
Polling Interval | In seconds | |
RegEx Filter | RegEx expression, which is applied on Expected Value |
The following Request Types
are currently supported:
- GET
- POST
The following Content Types
are currently supported:
- application/json
- application/vnd.api+json
- application/xml
- application/x-www-form-urlencoded
- text/html
- text/plain
- text/xml
JSONPath
JSONPath can be used for the Expected Property
parameter and allows to refer specific objects or elements in JSON responses.
JSONPath expressions can use the dot–notation.
$.node.element[0].title
or the bracket–notation
$['node']['element'][0]['title']
Syntax Elements
Description | |
---|---|
$ | The root object/element |
@ | The current object/element |
. or [] | child operator |
.. | recursive descent |
* | Wildcard |
?() | Applies a filter (script) expression |
() | script expression, using the underlying script engine |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{ExpectedProperty} | |
{RequestUri} | |
{Response} |
HTTP POST
Reacts to incoming HTTP POST requests from external systems.
Parameter | Description |
---|---|
Method Name | Defines the API URI of the trigger The trigger will be available at /api/v1/triggers/custom/{methodName} |
Expected JSON Property | The name of the expected JSON property |
Expected Value |
IHSE Crosspoint
Parameter | Description |
---|---|
Source | Console or CPU identifier including prefix (CON_ / CPU_). Example: CON_1003 |
Destination | Console or CPU identifier including prefix (CON_ / CPU_). Example: CON_1003 |
Accept any Source | If enabled, any source assigned to the destination will activate this trigger |
Polling Interval | In seconds |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Destination} | |
{Source} |
KPF Crosspoint
Reacts to changes of the internal matrices of Lawo Radio OnAir consoles.
Parameter | Description |
---|---|
Source ID | Multiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10). Leave empty if you enable Any Source . |
Destination ID | Multiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10) |
Accept Any Source | If enabled, any source routed to the configured destination(s) will invoke this trigger. |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Destination} | Destination ID |
{Source} | Source ID |
Licensing
Verifies periodically the current license and reacts depending on the current license state
Parameter | Description |
---|---|
Expected License Type |
The following License Types
are currently supported:
- None
- Demo
- Small
- Medium
- Large
- Extra Large
The Licensing trigger does not count towards the license limit.
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{ExpectedLicenseType} |
Livewire GPIO
Reacts to changes of Axia GPIO xNodes.
For more information on the GPIO configuration, please refer to the xNode manual.
Parameter | Description |
---|---|
Port | The xNode GPIO port number |
Pin | The xNode GPI (Pin) |
State | State of the GPI |
The following States
are currently supported:
- True
- False
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{GpioNumber} |
Marshall Switcher
Parameter | Description |
---|---|
Input |
Modbus TCP
Parameter | Description |
---|---|
Type | |
Address | |
Expected Value |
The following Types
are currently supported:
- Coil
- Discrete Input
- Input Register
- Holding Register
MQTT
Reacts to incoming MQTT messages.
Parameter | Description |
---|---|
Topic | Topic for the MQTT message |
Expected Value | Expected MQTT Value |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Value} | |
{Topic} |
Node State
Verifies the state of the current node
Parameter | Description |
---|---|
Expected Node State | Expected node state of the Core |
The following Node States
are currently supported:
- Primary
- Secondary
The Node State trigger does not count towards the license limit.
OSC
Reacts to incoming OSC messages.
Parameter | Description |
---|---|
OSC Path | |
Expected Value | |
Listen Port |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Origin} | |
{OscPath} | |
{OscValue} |
Ping
ICMP Trigger for monitoring devices via PING
Parameter | Description |
---|---|
Interval | In seconds |
Offline Threshold | Number of ping failures until the trigger changes its status to On |
Online Threshold | Number of successful pings until the trigger changes its status to Off |
Verify Round Trip Time | If enabled, replies with a round trip time higher than the configured value count as failure |
Max Round Trip Time | Replies with an RTT higher than the configured value count as a failure, if the option Verify Round Trip Time is enabled |
Remote Trigger
Parameter | Description |
---|---|
Remote Trigger ID | ID of the trigger on the external Broadcast Suite |
The Remote Trigger does not count towards the license limit.
RMON
Allows device monitoring via RMON
Parameter | Description |
---|---|
Port Number | The interface number / ID |
Parameter | The RMON parameter which should be monitored |
Expected Value | RMON Value |
The following Parameters
are currently supported:
- Drop Events
- Octets
- Packets
- Broadcast Packets
- Multicast Packets
- CRC Align Errors
- Undersize Packets
- Oversize Packets
- Fragments
- Jabbers
- Collisions
- Utilization
sFlow Generic Counter
If there is at least one sFlow trigger, the Broadcast Suite Core starts a sFlow Collector. This allows monitoring several counters (bandwidth, packet counters, errors) of sFlow compatible network devices
Parameter | Description |
---|---|
Interface Index | The interface index as configured in the devices sFlow configuration |
Counter | The observed generic counter |
Expected Value | The expected counter value |
The following Counters
are currently supported:
- Interface Type
- Interface Speed
- Interface Direction
- Interface Status
- Interface Promicious Mode
- Input Octets
- Input Bandwidth
- Input Utilization
- Input Unicast Packets
- Input Multicast Packets
- Input Broadcast Packets
- Input Dicards
- Input Errors
- Input Unkown Protocols
- Output Octets
- Output Bandwidth
- Output Utilization
- Output Unicast Packets
- Output Multicast Packets
- Output Broadcast Packets
- Output Dicards
- Output Errors
Silence Detector
Monitors an audio input and reacts when the audio level is below a configurable threshold.
Parameter | Description |
---|---|
Audio Input | Input which is monitored |
Threshold | The minimum audio level in dBFS (RMS) for the trigger to remain off |
Requires the Audio add-on.
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{DbFullScaleValue} |
SIP Register
Verifies if the given SIP User is registered.
Parameter | Description |
---|---|
Expected SIP Status Code | Status code for the trigger to remain off |
The following SIP Status Codes
are currently supported:
- Accepted
- AddressIncomplete
- AlternativeService
- Ambiguous
- AnonymityDisallowed
- BadEvent
- BadExtension
- BadGateway
- BadIdentityInfo
- BadRequest
- BusyEverywhere
- BusyHere
- CallIsBeingForwarded
- CallLegTransactionDoesNotExist
- ConditionalRequestFailed
- ConsentNeeded
- Decline
- DoesNotExistAnywhere
- ExtensionRequired
- FirstHopLacksOutboundSupport
- FlowFailed
- Forbidden
- Gone
- InternalServerError
- IntervalTooBrief
- InvalidIdentityHeader
- LoopDetected
- MaxBreadthExceeded
- MessageTooLarge
- MethodNotAllowed
- MovedPermanently
- MovedTemporarily
- MultipleChoices
- None
- NoNotification
- NotAcceptable
- NotAcceptableAnywhere
- NotAcceptableHere
- NotFound
- NotImplemented
- Ok
- PaymentRequired
- PreconditionFailure
- ProvideReferrerIdentity
- ProxyAuthenticationRequired
- Queued
- RequestEntityTooLarge
- RequestPending
- RequestTerminated
- RequestTimeout
- RequestURITooLong
- Ringing
- ServerTimeout
- ServiceUnavailable
- SessionIntervalTooSmall
- SessionProgress
- SIPVersionNotSupported
- TemporarilyUnavailable
- TooManyHops
- Trying
- Unauthorised
- Undecipherable
- UnknownResourcePriority
- UnsupportedCertificate
- UnsupportedMediaType
- UnsupportedURIScheme
- UseIdentityHeader
- UseProxy
SIP Ringing
Verifies if the given SIP User is ringing.
Parameter | Description |
---|---|
From | Optional Caller ID. You can separate multiple values by comma. |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{From} | |
{Tag} |
Skaarhoj Panel
Parameter | Description |
---|---|
Component ID | |
Status | |
Direction |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Direction} |
SNMP
Allows incoming SNMP TRAPs to be checked.
Parameter | Description |
---|---|
Expected OID | The TRAP OID for which the Expected Value has to be matched. If multiple TRAPs match the OID, only the first will be checked. |
Expected Value | The expected value for the Expected OID |
OID Filter | This filter can be used to check whether a specific OID exists in the TRAP. If found, all variable bindings are forwarded to Expected OID. This filter can be used alone or together with Value Filter. |
Value Filter | This filter can be used to check whether a specific value exists in the TRAP. If found, all variable bindings are forwarded to Expected Value. This filter can be used alone or together with OID Filter. |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{TrapOid} | |
{TrapValue} |
Sound4 Preset
Monitor the status of Sound4 BigVoice voice processors
Parameter | Description |
---|---|
Channel | The channel number, starting at 1 |
Preset Reference Mode | React to preset IDs or preset names |
Expected Preset | The expected preset ID / preset name |
The following Preset Reference Modes
are currently supported:
- ID
- Name
Sync Log
Checks if there are entries in the SyncLog table which are not Approved
.
So it can be checked if a sync has failed.
Parameter | Description |
---|---|
Interval | Interval in which the Sync Log table is checked In seconds |
Only available on supervisor nodes.
Syslog
Parameter | Description |
---|---|
Minimum Severity | |
Expected Message | |
Condition | |
Case Sensitive | |
RegEx Filter | RegEx expression, which is applied on Expected Message |
The following Minimum Severities
are currently supported:
- Emergency
- Alert
- Critical
- Error
- Warning
- Notice
- Informational
- Debug
The following Conditions
are currently supported:
- Any
- Contains
- Ends With
- Equals
- Starts With
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{Message} |
System Alert
Checks if there are any active system alerts.
Parameter | Description |
---|---|
Alert Type | The alert type which should be monitored Leave empty to monitor all alert types |
Include Acknowledged Alerts | If enabled, the trigger will remain On even if the alert has been acknowledged |
The following Alert Types
are currently supported:
- Agent Version Mismatch
- Ember+ Provider Port Closed
- License Overused
- Skaarhoj Port Closed
- Syslog Port Closed
- WhatsApp Transcription Settings Missing
The System Alert trigger does not count towards the license limit.
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{CurrentValue} | The alert type of the news active alert |
{ProjectType} | The project in which the alert appeared |
{AlertType} | The type of the alert |
{AlertDescription} | The alert description |
{AlertHint} | A hint how to solve the alert |
{AlertMessage} | The newest alert type |
{AlertAcknowledged} | True, if the alert was acknowledged |
TCP Listener
Reacts to incoming TCP messages.
Parameter | Description |
---|---|
Listen Port | Multiple triggers can use the same listen port |
Condition | The condition for the message filter |
Expected Message | |
Payload Type |
The following Conditions
are currently supported:
- Any
- Contains
- Ends With
- Equals
- Starts With
The following Payload Types
are currently supported:
- ASCII
- Byte Array
- UTF-8
TCP Port Check
Allows to check the status of an arbitrary TCP port
Parameter | Description |
---|---|
TCP Port | |
Polling Interval | In seconds |
Timeout | In seconds |
Telegram
Parameter | Description |
---|---|
Chat ID | |
Condition | |
Message |
The following Conditions
are currently supported:
- Any
- Contains
- Ends With
- Equals
- Starts With
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{UserId} | User ID of the message sender |
{UserName} | User name of the message sender |
Telnet
Allows to connect to an arbitrary device which supports Telnet connections. The configured command(s) are sent periodically to the device to poll the current status.
Parameter | Description |
---|---|
Command | Telnet Command |
Expected Response | |
Polling Interval | In seconds |
Text Carousel
Rotates a list of messages in sequential and repeating order. The display duration of the messages can be configured freely.
Parameter | Description | Supports Placeholders |
---|---|---|
Carousel Messages | If a placeholder resolves in multiple lines, it will be treated as a single carousel message. One line per message | ✔️ |
Display Duration | Display duration of each carousel message In seconds |
UDP Listener
Reacts to incoming UDP messages.
Parameter | Description |
---|---|
Listen Port | Multiple triggers can use the same listen port |
Condition | |
Payload | |
Payload Type |
The following Conditions
are currently supported:
- Any
- Contains
- Ends With
- Equals
- Starts With
The following Payload Types
are currently supported:
- ASCII
- Byte Array
- UTF-8
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{ConditionFulfilled} | 1 if Trigger condition is fulfilled, 0 otherwise |
Videohub Crosspoint
Monitors the output routing of Blackmagic Design Videohub devices.
The source and destination IDs start at 1.
Parameter | Description |
---|---|
Source | Single source ID or range Multiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10) |
Destination | Monitored destination ID |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{DestinationId} | The currently assigned destination ID |
{DestinationLabel} | User label of the current destination |
{SourceId} | The currently assigned source ID |
{SourceLabel} | User label of the current source |
Virtual
Parameter | Description |
---|---|
Default Trigger | You can add additional triggers on the Details page |
Undefined Value | Shown if the Virtual Trigger points to an undefined Trigger |
vMix Tally
Parameter | Description |
---|---|
Input | |
Type |
The following Types
are currently supported:
- Preview
- Program
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{AllTallies} | |
{TallyValue} |
WebSocket
Connects to a WebSocket and listens for incoming messages.
Parameter | Description |
---|---|
Socket Address | If the address does not start with ws, the hostname and port from the device is used WebSocket URI (e.g. ws://127.0.0.1/socket ) |
Init Command/Subscription | Init command which is sent as soon as the connection is established Subscription or initialization command |
Message Filter | Only messages matching this expression are processed Filter for incoming messages. The filter is applied before the trigger condition is verified. Supports JSONPath |
Expected Property | The expected message property Supports JSONPath |
Expected Value | |
RegEx Expression | RegEx expression, which is applied on Expected Value |
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{ReceivedMessage} |
WhatsApp
Reacts to incoming WhatsApp messages sent to the corresponding WhatsApp device.
Audio and video messages can optionally be automatically transcribed.
Parameter | Description | Supports Placeholders |
---|---|---|
Message Type | The expected message type | |
Mark as Read | If enabled, incoming messages will be marked as read | |
Save Media | If enabled, received media will be automatically downloaded to the media path | |
Media Path | Path for media storage. Supports system, static and dynamic placeholders. Required if Save Media is enabled | ✔️ |
Transcribe | If enabled, audio and video messages are automatically transcribed Enable Save Media to use this feature |
This requires an activated WhatsApp Business account.
If you want to transcribe messages automatically, you need to set the Infomaniak API Token in the API Keys settings.
The following Message Types
are currently supported:
- Any
- Text
- Media (any type)
- Image
- Audio
- Video
- Document
- Sticker
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{PhoneNumberId} | The ID of the phone number which has received the message |
{UserName} | The user name of the sender |
{MessageId} | Unique WhatsApp message ID |
{From} | Sender of the message (phone number) |
{Message} | Complete WhatsApp message |
{MediaFilePath} | Path to media file |
Windows User Logon
Reacts to a Windows user session event provided by an agent device.
Parameter | Description |
---|---|
Username | The user to be monitored Leave empty to monitor all users |
Expected Session Event | The expected session event triggered by the user |
Works only in combination with an agent device.
Requires the Agent add-on.
The following Session Events
are currently supported:
- Session Logon
- Session Logoff
- Session Unlock
- Session Lock
Placeholders
This trigger passes the following custom placeholders to the actions:
Placeholder | Description |
---|---|
{AgentUserName} | The name of the user who triggered the session event |
{AgentName} | The name of the agent device |
{AgentUserSessionEvent} | The triggered session event |
WMI
Allow monitoring the status of a Windows service or application.
A full list of properties can be found on https://docs.microsoft.com/en-us/windows/desktop/CIMWin32Prov/win32-process.
Parameter | Description |
---|---|
Type | |
Type Name | Name of the type to be monitored |
Interval | In seconds |
Check Is Running | If enabled, the trigger becomes active whenever the observed process is not running |
Property Name | The name of the property to check, e.g. Name |
Expected Property Value |
Only available on Windows installations.
The following Types
are currently supported:
- Process
- Service