Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Windmill mqtt_trigger API

The mqtt_trigger API from Windmill — 8 operation(s) for mqtt_trigger.

Windmill mqtt_trigger API is one of 59 APIs that Windmill publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include mqtt_trigger. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 8 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 1.694.0.

Requests are made against a single base URL, /api.

8 operations 8 paths 11 schemas 1 DELETE3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.694.0
Base URL
https://app.windmill.dev/api
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Windmill mqtt_trigger API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as token (cookieAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

mqtt_trigger 8
POST
/w/{workspace}/mqtt_triggers/create
Create Mqtt Trigger
createMqttTrigger 1 param body → 201
POST
/w/{workspace}/mqtt_triggers/update/{path}
Update Mqtt Trigger
updateMqttTrigger 2 params body → 200
DELETE
/w/{workspace}/mqtt_triggers/delete/{path}
Delete Mqtt Trigger
deleteMqttTrigger 2 params → 200
GET
/w/{workspace}/mqtt_triggers/get/{path}
Get Mqtt Trigger
getMqttTrigger 2 params → 200
GET
/w/{workspace}/mqtt_triggers/list
List Mqtt Triggers
listMqttTriggers 7 params → 200
GET
/w/{workspace}/mqtt_triggers/exists/{path}
Does Mqtt Trigger Exists
existsMqttTrigger 2 params → 200
POST
/w/{workspace}/mqtt_triggers/setmode/{path}
Set Enabled Mqtt Trigger
setMqttTriggerMode 2 params body → 200
POST
/w/{workspace}/mqtt_triggers/test
Test Mqtt Connection
testMqttConnection 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EditMqttTrigger (16 properties), NewMqttTrigger (16 properties), MqttTrigger (12 properties), TriggerExtraProperty (10 properties). Each schema is shown below with its type and property counts.

MqttClientVersion
string
MqttSubscribeTopic
object
2 properties 2 required
EditMqttTrigger
object
16 properties 6 required
TriggerExtraProperty
object
10 properties 9 required
MqttV3Config
object
1 property
ScriptArgs
object
The arguments to pass to the script or flow
MqttQoS
string
MqttTrigger
object
12 properties 2 required
MqttV5Config
object
3 properties
NewMqttTrigger
object
16 properties 5 required
TriggerMode
string
job trigger mode

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-mqtt-trigger-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill admin API
Windmill agent_workers API
Windmill app API
Windmill asset API
Windmill audit API
Windmill azure_trigger API
Windmill capture API
Windmill concurrencyGroups API
Windmill config API
Windmill documentation API
Windmill draft API
Windmill email_trigger API