Windmill

Developer tools None — the running job's own token Windmill TypeScript client

Drive Windmill from inside Windmill: run, deploy and delete scripts and flows, run code, watch the queue, manage schedules, resources, variables, groups and folders of the workspace — as steps of a flow, with no credential to set up.

Set up in 3 steps

1

Add a step

In a flow, add an action and search the hub for Windmill. There is no resource to create: each action authenticates with the token of the job it runs in.

2

Pick the target

Script, flow, schedule, resource, variable, group and folder inputs are dropdowns filled from your workspace.

3

Mind who runs it

The step can do what the user running the flow can do, in the workspace the flow runs in. A schedule runs as the user it is permissioned as. Add the Who Am I action to see which user that is.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Submit a script →

Who Am I

Script windmill Verified

Wait for Job

Script windmill Verified

Update Variable

Script windmill Verified

Update Script

Script windmill Verified

Update Schedule

Script windmill Verified

Update Resource

Script windmill Verified

Update Flow

Script windmill Verified

Run Script by Path and Wait for Result

Script windmill Verified

Run Script by Path

Script windmill Verified

Run Flow by Path and Wait for Result

Script windmill Verified

Run Flow by Path

Script windmill Verified

Run Code

Script windmill Verified

Remove User from Group

Script windmill Verified

Remove User or Group from Folder

Script windmill Verified

List Variables

Script windmill Verified

List Scripts

Script windmill Verified

List Schedules

Script windmill Verified

List Resources

Script windmill Verified

List Resource Types

Script windmill Verified

List Jobs

Script windmill Verified

List Groups

Script windmill Verified

List Folders

Script windmill Verified

List Flows

Script windmill Verified

List Completed Jobs

Script windmill Verified

List Audit Logs

Script windmill Verified

List Apps

Script windmill Verified

Get Workspace Settings

Script windmill Verified

Get Variable Value

Script windmill Verified

Get Script

Script windmill Verified

Get Schedule

Script windmill Verified

Flows

Multi-step workflows that already wire Windmill to something else.

All flows →

Azure Event Grid flow with preprocessor template

Flow windmill Verified

Nextcloud event flow template

Flow windmill Verified

Email trigger flow with preprocessor template

Flow windmill Verified

GCP flow with updated preprocessor template

Flow windmill Verified

HTTP route flow with signature verification template

Flow windmill Verified

NATS flow with preprocessor template

Flow windmill Verified

Kafka flow with preprocessor template

Flow windmill Verified

WebSocket flow with preprocessor template

Flow windmill Verified

HTTP flow with preprocessor template

Flow windmill Verified

MQTT flow with preprocessor template

Flow windmill Verified

SQS flow with preprocessor template

Flow windmill Verified

Resource types

The credential shapes the scripts on this page expect — pick the one your script asks for.

api_key_auth

View raw schema →
FieldTypeRequiredWhat it is
api_key_headerstringYes
api_key_secretstringYes
FieldTypeRequiredWhat it is
roleArnstringYes
regionstringNo

basic_http_auth

View raw schema →
FieldTypeRequiredWhat it is
usernamestringYes
passwordstringYes

cacertificate

View raw schema →
FieldTypeRequiredWhat it is
certificatestringNo
FieldTypeRequiredWhat it is
api_keystringNo
base_urlstringYese.g. https://my.custom.provider/v1
headersobjectNoCustom HTTP headers to include in AI requests
FieldTypeRequiredWhat it is
schemaobjectNo

signature_auth

View raw schema →
FieldTypeRequiredWhat it is
signature_providerstringYes
secret_keystringYes
authentication_configobjectNo

Questions

What can these actions access?

Exactly what the user running the job can, in the workspace the job runs in. They use the job's own token, so there is nothing to grant and nothing to rotate. Listing users, reading workspace settings or audit logs needs a workspace admin.

Can I act on another workspace or on the instance?

Not with the job's token: Windmill confines it to the job's workspace, so other workspaces and instance-level operations (workers, global users, instance settings) are refused. Use the Call Windmill API action and give it a user API token, ideally read from a secret variable.

The operation I need is not in the list.

Call Windmill API covers every operation. Its dropdown is built from your own instance's OpenAPI document, so it always matches the version you run. Give it the path parameters, query and body the operation takes; the workspace defaults to the current one.

Why does a secret reference end up resolved in a resource I created?

Windmill resolves $var: and $res: strings in a job's arguments before the script runs. A value passed to Create Resource therefore stores what the reference points to.