Overview
Send Codemagic build results to Callgoose SQIBS. A short post-build script posts the build status to your SQIBS API endpoint. SQIBS opens an incident when a build fails and resolves it when the next build of the same project succeeds.
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.
- Add a filter with these values (there is no built-in Codemagic template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "status" |
failure |
Opens an incident. |
| Resolve | "status" |
success |
Resolves the open incident. |
| Match | "project_id" |
The same for every build of the app, so the next green build resolves it. | |
| Title from | "title" |
Becomes the incident title. |
- Choose the Priority for these incidents and click Save.
Match on the project, not the build id: every build has a new build id, so a build id would never resolve.
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 post-build script in Codemagic
- In Codemagic, open the app's workflow in the Workflow Editor and add a post-build script.
- Paste this script:
STATUS="$CM_BUILD_STEP_STATUS" # success, failure or skipped
curl -s -X POST 'https://<your-endpoint>/sqibs-api/v1/process?from=codemagic&token=<your-token>' \
-H 'Content-Type: application/json' \
-d "{\"source\": \"codemagic\", \"status\": \"$STATUS\", \"project_id\": \"$CM_PROJECT_ID\", \"build_id\": \"$CM_BUILD_ID\", \"title\": \"Codemagic build $STATUS for project $CM_PROJECT_ID\"}"
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
CM_BUILD_STEP_STATUS is set by the Workflow Editor. In codemagic.yaml it is not available, so set the status yourself from your script's result before posting.
3. Save the workflow.
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.
- Start a build that fails (for example with a failing test).
- In SQIBS, a new incident opens, titled with the build status and project.
- Fix the build and run it again. When the status is
success, 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 post-build 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 build fails because a signing certificate expired, SQIBS can run a workflow that checks the certificate store and notifies the release owner with the details.
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.