Overview
Send Netlify deploy events to Callgoose SQIBS. Netlify posts the deploy to your SQIBS API endpoint when a deploy fails and when a deploy succeeds. SQIBS opens an incident for the failure and resolves it with the next successful deploy of the same project.
How it works
error opens it, ready 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 Netlify. It fills in these filter values:
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "state" |
error |
Opens an incident. |
| Resolve | "state" |
ready |
Resolves the open incident. |
| Match | "site_id" |
Ties the resolve message to the incident it opened. | |
| Title from | "title" |
Becomes the incident title. | |
| Description from | "error_message" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
The template takes the incident title from "title", which holds the commit title and is often empty for manual deploys. Change Incident title from to "name", the project name.
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 two deploy notifications in Netlify
- In Netlify, open the project and go to Project configuration > Notifications > Deploy notifications.
- Click Add notification and choose HTTP POST request.
- Set the event to Deploy failed, and the URL to notify to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=netlify&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. Add a second HTTP POST notification with the same URL for Deploy succeeded, so SQIBS can resolve the incident.
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.
- Push a commit that breaks the build.
- In SQIBS, a new incident opens, described with Netlify's error message. The payload looks like this (shortened):
{
"id": "673afd2603cc1400082a4a6c",
"site_id": "a2036e63-1af8-40eb-80d3-2a0960632913",
"state": "error",
"name": "shop-web",
"ssl_url": "https://shop-web.netlify.app",
"admin_url": "https://app.netlify.com/projects/shop-web",
"error_message": "Failed during stage 'building site': Build script returned non-zero exit code: 2",
"title": "Fix checkout total",
"branch": "main"
}
- Fix the build and deploy again. Netlify sends
"state": "ready"for the samesite_id, 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 Netlify notification.
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 production deploy fails, SQIBS can run a workflow that checks whether the live site still answers and, if not, restores the last published deploy.
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.