Script kind

You can attach additional functionalities to Scripts by specializing them into specific Script kinds.

From the Settings of a script, the "Metadata" tab lets you define the following Script kinds:

Actions

Actions are the basic building blocks for the flows.

Scripts quickstart

Start writing scripts in Python, TypeScript, Go, PHP, Bash and Sql.

Flows quickstart

Learn how to build flows.

Trigger scripts

These are used as the first step in flows, most commonly with an internal state and a schedule to watch for changes on a external system, and compare it to the previously saved state. If there are changes,it triggers the rest of the flow, i.e. subsequent Scripts.

Trigger scripts

Trigger scripts are designed to pull data from an external source and return all of the new items since the last run, without resorting to external webhooks.

Schedules

Windmill provides the same set of features as CRON, but with a user interface and control panels.

Approval scripts

Suspend a flow until it's approved. An Approval Script will interact with the Windmill API using any of the Windmill clients to retrieve a secret approval URL and resume/cancel endpoints. Most common scenario for Approval scripts is to send an external notification with an URL that can be used to resume or cancel a flow.

Suspend & Approval / Prompts

Flows can be suspended until resumed or canceled event(s) are received.

Error handlers

Handle errors for Flows after all retries attempts have been exhausted. The Flow keeps its failed status, unless the error handler returns an object with recover: true: the Flow is then considered "recovered" and gets a success status. See Mark the flow as successful.

Error handler

The error handler is a special flow step that is executed when an error occurs in the flow.