Scripts can be triggered in 6 ways.
- Auto-generated UIs
- Customized UIs with the App Editor
- Trigger Scripts from Flows
- Schedule the Execution of a Script
- Trigger Scripts from CLI (Command Line Interface)
Triggers from external events:
- Trigger Scripts from Webhooks, including from Slack or Emails
Scripts are sequences of instructions that automates tasks or performs specific operations. In Windmill, they are hosted on workspaces.
Windmill automatically generates user interfaces (UIs) for scripts and flows based on their parameters.
By analyzing the main function parameters, it creates an input specification in the JSON Schema format, which is then used to render the UI. Users do not need to interact with the JSON Schema directly, as Windmill simplifies the process and allows for optional UI customization.
This feature is also usable directly in the script editor to test a script in the making:
More details on our page dedicated to Auto-generated UIs.
Customized UIs with the App Editor
Windmill embeds a WYSIWYG app editor. It allows you to build your own UI with drag-and-drop components and to connect your data to scripts and flows in minutes.
More details on our page dedicated to Windmill App Editor.
Trigger Scripts from Flows
Flows are basically sequences of scripts that execute on after each other or in parallel.
More details on our page dedicated to Triggering flows.
Schedule the Execution of a Script
Windmill allows you to schedule scripts using a user-friendly interface and control panels, similar to cron but with more features.
You can create schedules by specifying a script or flow, its arguments, and a CRON expression to control the execution frequency, ensuring that your tasks run automatically at the desired intervals.
More details on our page dedicated to Scheduling jobs.
Trigger Scripts from CLI (Command Line Interface)
wmill cli allows you to interact with Windmill instances right from your terminal.
More details on our pages dedicated to CLI.
Triggers from external events
Trigger Scripts from Webhooks
In Windmill, webhooks are autogenerated for each Script and Flow, providing either asynchronous or synchronous execution modes.
These webhooks accept incoming HTTP requests, allowing users to easily trigger their Windmill scripts/flows from external services by simply sending a POST request to the appropriate authentified webhook URL (requires passing a token as Bearer or query arg). Their purpose is to have the script run when it receives an input from its associated webhook.
Each script (and flow) has its own webhooks on Windmill ...
... which you can trigger from service providers, like Github here:
More details on our page dedicated to Webhooks.
Webhooks: Trigger Scripts from Slack
One use case of webhooks is building a Slackbot with Windmill.
Windmill uses Slack to trigger scripts and flows by establishing Slackbots and creating specific commands. By connecting Slack with Windmill, parsing incoming Slack commands, and leveraging Windmill workflows, operational teams can trigger complex automations directly from Slack.
Webhooks: Trigger Scripts from Emails
One use case of webhooks is triggering scripts via inbound emails using Mailchimp.
Windmill leverages Mailchimp Mandrill's capabilities to initiate scripts and flows via email-triggered events. By parsing inbound emails and routing the content to Windmill through webhooks, scripts or flows are activated, enabling automation based on email content or just their arrival.