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

Event triggers - HTTP, WebSocket, Kafka, NATS, Postgres, SQS, MQTT.

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

Tagged areas include Triggers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.745.0.

Requests are made against 2 base URLs: https://app.windmill.dev/api, http://localhost:8000/api.

5 operations 5 paths 2 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Windmill Triggers 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.

  • bearerAuth — Bearer token created in the Windmill UI under account settings, passed as Authorization: Bearer YOURTOKEN.
  • cookieAuth — Session cookie set by the Windmill web UI after login.

Paths & Operations 5

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

Triggers 5

Event triggers - HTTP, WebSocket, Kafka, NATS, Postgres, SQS, MQTT.

GET
/w/{workspace}/http_triggers/list
List HTTP triggers
listHttpTriggers 1 param → 200401
GET
/w/{workspace}/websocket_triggers/list
List WebSocket triggers
listWebsocketTriggers 1 param → 200401
POST
/w/{workspace}/websocket_triggers/create
Create a WebSocket trigger
createWebsocketTrigger 1 param body → 201401
GET
/w/{workspace}/kafka_triggers/list
List Kafka triggers
listKafkaTriggers 1 param → 200401
GET
/w/{workspace}/postgres_triggers/list
List Postgres triggers
listPostgresTriggers 1 param → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Trigger (6 properties), Error (1 property). Each schema is shown below with its type and property counts.

Trigger
object
6 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-dev-triggers-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill Apps API
Windmill Audit API
Windmill Flows API
Windmill Folders API
Windmill Groups API
Windmill Jobs API
Windmill OIDC API
Windmill Resources API
Windmill Schedules API
Windmill Scripts API
Windmill Users API
Windmill Variables API