Overview
Send Wormly host alerts to Callgoose SQIBS. A webhook contact posts each alert and recovery to your SQIBS API endpoint. SQIBS opens an incident when a sensor fails and resolves it when the host recovers.
How it works
isrecovery: 0 opens it, 1 closes it.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.
- In Select Integration Template, choose Wormly. It fills in these filter values:
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "isrecovery" |
0 |
Opens an incident. |
| Resolve | "isrecovery" |
1 |
Resolves the open incident. |
| Match | "hostid" |
Ties the resolve message to the incident it opened. | |
| Title from | "alertlevel_name" |
Becomes the incident title. | |
| Description from | "failedsensors".[0]."message" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
The template is a starting point, not a lock-in: every value stays visible and you can change it.
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 a webhook contact in Wormly
- In Wormly, go to Alerts > Contacts and click Create New Contact.
- Choose Webhook as the contact type, give it a name, and enter your SQIBS endpoint as the URL:
https://<your-endpoint>/sqibs-api/v1/process?from=wormly&token=<your-token>
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
- Save the contact and add it to the alert recipients of the hosts you want in SQIBS.
Step 3: Monitor a host
- Click Create Host, give it a name and choose the testing interval and monitoring node, then Add This Host.
- Add a sensor, for example HTTP Request with the URL and the expected response code, and save.
Step 4: 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.
- Set a sensor to expect a response the site does not give.
- In SQIBS, a new incident opens, described with the failed sensor's message. Wormly's payload looks like this:
{
"hostid": 122653,
"name": "Shop",
"isrecovery": 0,
"downtime": 0,
"alertlevel": 1,
"alertlevel_name": "Detected Error",
"failedsensors": [
{
"type": "HTTP",
"sensorid": 410038,
"message": "Got response code 503, expected 200"
}
]
}
- When the host recovers, Wormly sends
"isrecovery": 1for the samehostid, and SQIBS resolves the incident.
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 Wormly contact.
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 Wormly reports a 503 from the shop, SQIBS can run a workflow that restarts the application and rechecks the sensor.
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.