Overview
Send Calibre web performance alerts to Callgoose SQIBS. A Calibre webhook posts to your SQIBS API endpoint when a snapshot finishes or a performance budget is exceeded. Your SQIBS filter decides which messages become incidents, for example budget breaches only.
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 Calibre template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "event" |
budget |
Opens an incident for budget events only. |
| Title from | "site"."name" |
Becomes the incident title. |
- Choose the Priority for these incidents and click Save.
Calibre does not send a message when the problem clears, so close these incidents in SQIBS (or with an automation workflow) when the fix is in.
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 a webhook in Calibre
- In Calibre, open the site and go to Settings > Integrations, then Add a Webhook.
- Enter your SQIBS endpoint as the URL:
https://<your-endpoint>/sqibs-api/v1/process?from=calibre&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.
- Choose the events to send. Budget notifications are the ones worth an incident; snapshot notifications are sent for every test.
- Save the webhook and send a test.
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.
- Send a test from the webhook, or set a tight budget and run a snapshot.
- Open the API log and check the event name and fields Calibre sent, then adjust the trigger value and title key if they differ from the values above.
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 Calibre webhook.
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 Calibre reports the home page over its weight budget after a deploy, SQIBS can run a workflow that purges the CDN cache and reruns the snapshot.
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.