Skip to content

Integrations API and MQTT

The Integrations (API / MQTT) section connects the controller to external systems after network settings are configured.

UI path

  1. Open Configuration.
  2. Configure MQTT broker/network details on Connections if needed.
  3. Select Connections.
  4. Expand Integrations (API / MQTT).
  5. Add or edit integration systems and messages.

Controls

ControlWhat it does
System IDIntegration friendly name used by behavior actions
Type/protocolMQTT, HTTP/API or OSC
EnabledTurns the target on or off
Destination/base/path/topicAddress or route for messages
Publish optionsSelects which events, state, inputs, analog, health, or errors are published
Subscribe commandEnables inbound control when supported
TimeoutLimits how long the controller waits for the external target

By default when you add an integration it will publish all of the configured options to the network and they can then be subscribed or listened for by external systems, other prop controllers, room control software and more. Once an integration is added you can send messages directly out over it as action steps from Behaviors if there is a specific message you need to send. You can also add Manual Routes within this Integrations section to specifically listen for messages. You can optionally put the payload into a defined Variable for later use or after a Manual Route is added you can use it as a trigger for Behaviors.