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 websocket_trigger API

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

Windmill websocket_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 websocket_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 8 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 8 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 websocket_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.

websocket_trigger 8
POST
/w/{workspace}/websocket_triggers/create
Create Websocket Trigger
createWebsocketTrigger 1 param body → 201
POST
/w/{workspace}/websocket_triggers/update/{path}
Update Websocket Trigger
updateWebsocketTrigger 2 params body → 200
DELETE
/w/{workspace}/websocket_triggers/delete/{path}
Delete Websocket Trigger
deleteWebsocketTrigger 2 params → 200
GET
/w/{workspace}/websocket_triggers/get/{path}
Get Websocket Trigger
getWebsocketTrigger 2 params → 200
GET
/w/{workspace}/websocket_triggers/list
List Websocket Triggers
listWebsocketTriggers 7 params → 200
GET
/w/{workspace}/websocket_triggers/exists/{path}
Does Websocket Trigger Exists
existsWebsocketTrigger 2 params → 200
POST
/w/{workspace}/websocket_triggers/setmode/{path}
Set Enabled Websocket Trigger
setWebsocketTriggerMode 2 params body → 200
POST
/w/{workspace}/websocket_triggers/test
Test Websocket Connection
testWebsocketConnection 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are NewWebsocketTrigger (18 properties), EditWebsocketTrigger (17 properties), WebsocketTrigger (14 properties), TriggerExtraProperty (10 properties). Each schema is shown below with its type and property counts.

WebsocketTriggerInitialMessage
TriggerExtraProperty
object
10 properties 9 required
ScriptArgs
object
The arguments to pass to the script or flow
EditWebsocketTrigger
object
17 properties 7 required
TriggerMode
string
job trigger mode
NewWebsocketTrigger
object
18 properties 7 required
WebsocketHeartbeat
object
3 properties 2 required
WebsocketTrigger
object
14 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-websocket-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