Sign in
mqtt_trigger

create mqtt trigger

post/w/{workspace}/mqtt_triggers/create

Path parameters

workspacestring required

Request body

mqtt_resource_pathstring required

Path to the MQTT resource containing broker connection configuration

client_idstring nullable

MQTT client ID for this connection

client_version'v3' | 'v5'
pathstring required

The unique Windmill path for this trigger. Must be of the form u/<user>/<path> or f/<folder>/<path>. This is the trigger object path, not the HTTP route path.

script_pathstring required

Path to the script or flow to execute when a message is received

is_flowboolean required

True if script_path points to a flow, false if it points to a script

mode'enabled' | 'disabled' | 'suspended'

job trigger mode

error_handler_pathstring

Path to a script to run when the triggered job fails. A bare path, without the script/ or flow/ prefix a schedule error handler takes; it cannot be a flow.

error_handler_argsScriptArgs

The arguments to pass to the script or flow

retryRetry — unresolved $ref
permissioned_asstring

The user or group this trigger runs as. Used during deployment to preserve the original trigger owner.

preserve_permissioned_asboolean

When true and the caller is a member of the 'wm_deployers' group, preserves the original permissioned_as value instead of overwriting it.

labelsstring[]

Response

mqtt trigger created

Changes