Overview
Get paged when a Windmill script or flow fails. A workspace error handler runs whenever a job fails, and a few lines of code post the failure to your SQIBS API endpoint. SQIBS opens an incident for each failed job.
How it works
Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.
Step 1: Add the API filter in SQIBS
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- Add a filter with these values (there is no built-in Windmill template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "event" |
job_failed |
Opens an incident for each failed job. |
| Match | "path" |
One open incident per script or flow. | |
| Title from | "path" |
Becomes the incident title. | |
| Description from | "error" |
The error from the failed job. |
- Choose the Priority for these incidents and click Save.
The workspace webhook in Windmill sends an event for every change in the workspace (a script saved, a flow created), not for failures, so use the error handler instead.
Not sure of a key? Send one test message first (step below), then build the filter from the real payload.
In the API Integration window, click the round
{} button at the bottom right. Paste a payload that SQIBS received (copy it from the API log). SQIBS lists every key with its value, each with a copy button. Copy the key into Payload JSON key and the value into Key value contains. No need to read the JSON by hand.Step 2: Add the error handler in Windmill
- In Windmill, create a script with this code (store the token in a Windmill secret variable rather than in the script):
// Windmill workspace error handler (TypeScript, Bun)
export async function main(
path: string,
workspace_id: string,
job_id: string,
is_flow: boolean,
error: object,
) {
await fetch("https://<your-endpoint>/sqibs-api/v1/process?from=windmill&token=<your-token>", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
event: "job_failed",
workspace: workspace_id,
path,
job_id,
is_flow,
error: JSON.stringify(error).slice(0, 2000),
}),
});
}
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
- Go to Workspace settings > Error handler, choose the script, and save.
Step 3: Test it
The API log saves payloads only while API Tracking is on for the token. Turn it on under API Tokens before you test; it switches itself off after 48 hours.
- Run a script that throws an error, from a schedule.
- In SQIBS, a new incident opens, titled with the script path.
No incident? Open the API log (with API Tracking on). If the payload is there, the filter did not match it: paste it into the JSON key creator and check the keys. If it is not there, check the URL and token in the error handler script.
Fix known issues automatically
Many alerts have a known fix: restart a service, clear a full disk, run a health check. SQIBS can run that fix for you the moment the incident opens. This is event-driven auto remediation. For example, when a nightly data sync flow fails, SQIBS can run a workflow that checks the source database connection and reruns the sync.
Safe by design. SQIBS runs only workflows your own engineers wrote and approved for your environment. Nothing is guessed or generated: the same steps an engineer would run by hand, run sooner. If the workflow does not fix the issue, the engineer is paged as usual.
To set it up, in the same API filter:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- Waiting time for escalate to escalation policies: how many minutes to give the workflow before paging the on-call engineer.
Start with low-risk workflows, such as a health check, and add fixes as you come to trust them.
Learn more:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.