Overview
Send Jenkins build failures to Callgoose SQIBS. A small curl call in the pipeline's post section sends the build result to your SQIBS API endpoint. SQIBS opens an incident when a build fails and resolves it when the next build is fixed.
How it works
FAILURE opens it, SUCCESS 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 Jenkins. It fills in these filter values:
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | (none) | (anything) | No key, so every message opens an incident. |
- Choose the Priority for these incidents and click Save.
The Jenkins template has no key, so every message opens an incident. With the script below, use these values instead:
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "status" |
FAILURE |
Opens an incident. |
| Resolve | "status" |
SUCCESS |
Resolves the open incident. |
| Match | "job" |
Ties the fixed build to the incident its failure opened. | |
| Title from | "title" |
Becomes the incident title. |
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 the notify script
- Store your SQIBS token as a Jenkins Secret text credential, and expose it to the job as
SQIBS_TOKEN(for example withwithCredentials). - Save this script on the agent as
callgoose_notify, or inline thecurlcall:
#!/bin/sh
# callgoose_notify <STATUS>: posts the build result to Callgoose SQIBS. Keep the token in a Jenkins credential.
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=jenkins" \
-H "Authorization: Bearer $SQIBS_TOKEN" \
-H 'Content-Type: application/json' \
--data-raw "{\"job\": \"$JOB_NAME\", \"build\": \"$BUILD_NUMBER\", \"status\": \"$1\", \"url\": \"$BUILD_URL\", \"title\": \"$JOB_NAME build $1\"}"
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Step 3: Call it from the pipeline
In a declarative pipeline, the post section runs after the stages. failure runs when the build fails; fixed runs when a build succeeds after a failure:
pipeline {
agent any
stages {
stage('Build') { steps { sh './build.sh' } }
}
post {
failure { sh 'callgoose_notify FAILURE' }
fixed { sh 'callgoose_notify SUCCESS' }
}
}
For freestyle jobs, the Post build task plugin does the same: add a post-build task that matches a log text such as BUILD FAILED and runs the script with FAILURE.
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.
- Make a build fail on purpose, for example with a step that runs
exit 1. - In SQIBS, a new incident opens, titled
<job> build FAILURE. The payload looks like this:
{
"job": "shop-api",
"build": "142",
"status": "FAILURE",
"url": "https://jenkins.example.com/job/shop-api/142/",
"title": "shop-api build FAILURE"
}
- Fix the build and run it again. The
fixedblock sendsSUCCESSand 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 notify 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 deployment job fails, SQIBS can run a workflow that checks the target servers and rolls back to the last good release.
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.