Skip to main content

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:

ParameterDescription
NameName to identify this model
EnabledIndicates if the model is enabled
Trigger TypeType to decide which parameters are needed
DeviceThe associated device
CategoryThe associated category
DescriptionAdditional description
Initial StatusStatus which is used after initialization
LoggingIf enabled, this item will create log entries
Last StateThe last TriggerState
OccurrencesNumber of times this item has occurred
PulseIf enabled, this Trigger automatically returns to the status Off after the configured time in the PulseDuration
Pulse DurationDuration 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 InitSet true, to restore the StatusState (from LastState) during initialization
Sequence NumberThe unique sequence ID of this item. Used for the Ember+ provider OID.
Status CodeThe current status code
Status MessageThe current status message
StatusThe current status
Substitution TableThe associated Substitution Table
Switch-off timeThe switch-off time defines how long a measurement value needs to mismatch the trigger configuration before it changes its status to Off
Switch-on timeThe 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
ToggleWhen 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)

ParameterDescription
Listen PortMust match the Bionic Studio configuration
GPO NumberPhoneBox GPO Number
GPO ValueExpected GPO Value

The following GPO Values are currently supported:

  • True
  • False

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{ConditionFulfilled}1 if Trigger condition is fulfilled, 0 otherwise

Bionic Studio Status

ParameterDescription
Command
Item Name / ID
Polling IntervalIn 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:

PlaceholderDescription
{ExpectedProperty}
{RequestUri}
{Response}

Blackmagic ATEM Tally

Listens and reacts to inputs of Blackmagic Design ATEM switchers.

ParameterDescription
InputAs shown in the ATEM Remote Software
TypeExpected input state
info

Only available on Windows installations.

The following Types are currently supported:

  • Preview
  • Program

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{InputId}
{InputLongName}
{InputShortName}
{ProductName}

Codec Control

ParameterDescription
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

ParameterDescription
Cron ExpressionDefines the intermittency in which the trigger becomes the status On
Please refer to the manual or cronmaker.com for the detailed syntax
DurationDuration the trigger keeps the statusOn
In seconds
On ValueLeave empty for default value (On = 1)
Off ValueLeave empty for default value (Off = 0)
Default ValueLeave 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

ParameterDescription
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

ParameterDescription
Logic IDID 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:

PlaceholderDescription
{LogicId}From the trigger configuration

Disk Usage

Allows monitoring the free storage space of a volume.

ParameterDescription
VolumeThe volume to inspect
C:\ or /dev/vda1
ThresholdIf the free disk space is less than or equal to this value, the trigger will switch to On
In %
info

If the monitored volume is not found, the trigger will switch to On.

License

The Disk Usage trigger does not count towards the license limit.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{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.

ParameterDescription
Type
Slot0 = Any (reacts to any value)
Key0 = 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:

PlaceholderDescription
{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

ParameterDescription
Default StatusDoes 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:

PlaceholderDescription
{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.

ParameterDescription
Ember+ PathPath to property as shown in Ember+ Viewer
The path to the parameter, e.g. /Root/Input 1/Gain
Expected Value
Parameter OIDObject Identifier (OID) of parameter. Will be populated automatically if field is left empty.
RegEx FilterRegEx expression, which is applied on Expected Value

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{EmberPlusOid}
{OriginalValue}

Ember+ GPIO

Reacts to changes of Ember+ GPIO nodes of a Lawo Radio Console device.

ParameterDescription
GPIO Node NameName of the Ember+ GPIO element as shown in TinyEmber or Lawo configuration
GPO NumberGPO Output Number
GPO Value
Parameter OIDObject 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:

PlaceholderDescription
{EmberPlusOid}
{GpioNumber}

Ember+ Matrix

Reacts to changes of Ember+ matrices.

ParameterDescription
Matrix PathPath of the Ember+ matrix node as shown in the Ember+ Viewer
Source IDMultiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10). Leave empty if you enable Any Source.
Accept any sourceIf enabled, any source routed to the configured destination(s) will invoke this trigger.
Destination IDMultiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10)
Parameter OIDObject Identifier (OID) of parameter. Will be populated automatically if field is left empty.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{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.

ParameterDescription
Expected Value

File

Allows you to read a file in a regular interval and compare its content with the expected value.

ParameterDescriptionSupports
Placeholders
File PathFull path to the file, including the filename. Supports static placeholders.✔️
Polling IntervalIn seconds
Read Mode
Expected ValueExpected file content
info

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:

PlaceholderDescription
{FullPath}

G&D KVM Crosspoint

Reacts to changes on Guntermann & Drunck KVM matrix devices

ParameterDescription
SourceConsole Name
Accept any SourceIf enabled, any source routed to the configured destination will invoke this trigger
Source ConditionOnly sources where the names match the expression are processed
RegEx expression
DestinationCPU (Destination)
Accept any DestinationIf enabled, any destination will invoke this trigger
Destination ConditionOnly destinations where the names match the expression are processed
RegEx expression

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{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.

ParameterDescriptionSupports
Placeholders
Request URIURI 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
PayloadSupports system, static and dynamic placeholders.✔️
Message FilterFilter for incoming messages. The filter is applied before the trigger condition is verified. Supports JSONPath
Expected PropertyThe property which is being monitored.
Supports JSONPath / XPath
Expected Value
Polling IntervalIn seconds
RegEx FilterRegEx 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:

PlaceholderDescription
{ExpectedProperty}
{RequestUri}
{Response}

HTTP POST

Reacts to incoming HTTP POST requests from external systems.

ParameterDescription
Method NameDefines the API URI of the trigger
The trigger will be available at /api/v1/triggers/custom/{methodName}
Expected JSON PropertyThe name of the expected JSON property
Expected Value

IHSE Crosspoint

ParameterDescription
SourceConsole or CPU identifier including prefix (CON_ / CPU_). Example: CON_1003
DestinationConsole or CPU identifier including prefix (CON_ / CPU_). Example: CON_1003
Accept any SourceIf enabled, any source assigned to the destination will activate this trigger
Polling IntervalIn seconds

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{Destination}
{Source}

KPF Crosspoint

Reacts to changes of the internal matrices of Lawo Radio OnAir consoles.

ParameterDescription
Source IDMultiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10). Leave empty if you enable Any Source.
Destination IDMultiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10)
Accept Any SourceIf enabled, any source routed to the configured destination(s) will invoke this trigger.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{Destination}Destination ID
{Source}Source ID

Licensing

Verifies periodically the current license and reacts depending on the current license state

ParameterDescription
Expected License Type

The following License Types are currently supported:

  • None
  • Demo
  • Small
  • Medium
  • Large
  • Extra Large
License

The Licensing trigger does not count towards the license limit.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{ExpectedLicenseType}

Livewire GPIO

Reacts to changes of Axia GPIO xNodes.
For more information on the GPIO configuration, please refer to the xNode manual.

ParameterDescription
PortThe xNode GPIO port number
PinThe xNode GPI (Pin)
StateState of the GPI

The following States are currently supported:

  • True
  • False

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{GpioNumber}

Marshall Switcher

ParameterDescription
Input

Modbus TCP

ParameterDescription
Type
Address
Expected Value

The following Types are currently supported:

  • Coil
  • Discrete Input
  • Input Register
  • Holding Register

MQTT

Reacts to incoming MQTT messages.

ParameterDescription
TopicTopic for the MQTT message
Expected ValueExpected MQTT Value

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{Value}
{Topic}

Node State

Verifies the state of the current node

ParameterDescription
Expected Node StateExpected node state of the Core

The following Node States are currently supported:

  • Primary
  • Secondary
License

The Node State trigger does not count towards the license limit.

OSC

Reacts to incoming OSC messages.

ParameterDescription
OSC Path
Expected Value
Listen Port

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{Origin}
{OscPath}
{OscValue}

Ping

ICMP Trigger for monitoring devices via PING

ParameterDescription
IntervalIn seconds
Offline ThresholdNumber of ping failures until the trigger changes its status to On
Online ThresholdNumber of successful pings until the trigger changes its status to Off
Verify Round Trip TimeIf enabled, replies with a round trip time higher than the configured value count as failure
Max Round Trip TimeReplies with an RTT higher than the configured value count as a failure, if the option Verify Round Trip Time is enabled

Remote Trigger

ParameterDescription
Remote Trigger IDID of the trigger on the external Broadcast Suite
License

The Remote Trigger does not count towards the license limit.

RMON

Allows device monitoring via RMON

ParameterDescription
Port NumberThe interface number / ID
ParameterThe RMON parameter which should be monitored
Expected ValueRMON 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

ParameterDescription
Interface IndexThe interface index as configured in the devices sFlow configuration
CounterThe observed generic counter
Expected ValueThe 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.

ParameterDescription
Audio InputInput which is monitored
ThresholdThe minimum audio level in dBFS (RMS) for the trigger to remain off
info

Requires the Audio add-on.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{DbFullScaleValue}

SIP Register

Verifies if the given SIP User is registered.

ParameterDescription
Expected SIP Status CodeStatus 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.

ParameterDescription
FromOptional Caller ID. You can separate multiple values by comma.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{From}
{Tag}

Skaarhoj Panel

ParameterDescription
Component ID
Status
Direction

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{Direction}

SNMP

Allows incoming SNMP TRAPs to be checked.

ParameterDescription
Expected OIDThe TRAP OID for which the Expected Value has to be matched.
If multiple TRAPs match the OID, only the first will be checked.
Expected ValueThe expected value for the Expected OID
OID FilterThis 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 FilterThis 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:

PlaceholderDescription
{TrapOid}
{TrapValue}

Sound4 Preset

Monitor the status of Sound4 BigVoice voice processors

ParameterDescription
ChannelThe channel number, starting at 1
Preset Reference ModeReact to preset IDs or preset names
Expected PresetThe 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.

ParameterDescription
IntervalInterval in which the Sync Log table is checked
In seconds
info

Only available on supervisor nodes.

Syslog

ParameterDescription
Minimum Severity
Expected Message
Condition
Case Sensitive
RegEx FilterRegEx 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:

PlaceholderDescription
{Message}

System Alert

Checks if there are any active system alerts.

ParameterDescription
Alert TypeThe alert type which should be monitored
Leave empty to monitor all alert types
Include Acknowledged AlertsIf 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
License

The System Alert trigger does not count towards the license limit.

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{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.

ParameterDescription
Listen PortMultiple triggers can use the same listen port
ConditionThe 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

ParameterDescription
TCP Port
Polling IntervalIn seconds
TimeoutIn seconds

Telegram

ParameterDescription
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:

PlaceholderDescription
{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.

ParameterDescription
CommandTelnet Command
Expected Response
Polling IntervalIn seconds

Rotates a list of messages in sequential and repeating order. The display duration of the messages can be configured freely.

ParameterDescriptionSupports
Placeholders
Carousel MessagesIf a placeholder resolves in multiple lines, it will be treated as a single carousel message.
One line per message
✔️
Display DurationDisplay duration of each carousel message
In seconds

UDP Listener

Reacts to incoming UDP messages.

ParameterDescription
Listen PortMultiple 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:

PlaceholderDescription
{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.

ParameterDescription
SourceSingle source ID or range
Multiple values can be separated by comma, ranges by minus (e.g. 1,2,3-10)
DestinationMonitored destination ID

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{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

ParameterDescription
Default TriggerYou can add additional triggers on the Details page
Undefined ValueShown if the Virtual Trigger points to an undefined Trigger

vMix Tally

ParameterDescription
Input
Type

The following Types are currently supported:

  • Preview
  • Program

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{AllTallies}
{TallyValue}

WebSocket

Connects to a WebSocket and listens for incoming messages.

ParameterDescription
Socket AddressIf 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/SubscriptionInit command which is sent as soon as the connection is established
Subscription or initialization command
Message FilterOnly messages matching this expression are processed
Filter for incoming messages. The filter is applied before the trigger condition is verified. Supports JSONPath
Expected PropertyThe expected message property
Supports JSONPath
Expected Value
RegEx ExpressionRegEx expression, which is applied on Expected Value

Placeholders

This trigger passes the following custom placeholders to the actions:

PlaceholderDescription
{ReceivedMessage}

WhatsApp

Reacts to incoming WhatsApp messages sent to the corresponding WhatsApp device.
Audio and video messages can optionally be automatically transcribed.

ParameterDescriptionSupports
Placeholders
Message TypeThe expected message type
Mark as ReadIf enabled, incoming messages will be marked as read
Save MediaIf enabled, received media will be automatically downloaded to the media path
Media PathPath for media storage. Supports system, static and dynamic placeholders.
Required if Save Media is enabled
✔️
TranscribeIf enabled, audio and video messages are automatically transcribed
Enable Save Media to use this feature
info

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:

PlaceholderDescription
{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.

ParameterDescription
UsernameThe user to be monitored
Leave empty to monitor all users
Expected Session EventThe expected session event triggered by the user
info

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:

PlaceholderDescription
{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.

ParameterDescription
Type
Type NameName of the type to be monitored
IntervalIn seconds
Check Is RunningIf enabled, the trigger becomes active whenever the observed process is not running
Property NameThe name of the property to check, e.g. Name
Expected Property Value
info

Only available on Windows installations.

The following Types are currently supported:

  • Process
  • Service