Overview

Send Travis CI build results to Callgoose SQIBS. Two short curl steps in .travis.yml post a JSON message to your SQIBS API endpoint when a build fails and when it passes. SQIBS opens an incident for a failed branch and resolves it when the branch is green again.

You need
A Travis CI repository you can configure, and a SQIBS API token
Setup time
About 10 minutes
Result
Failed builds open SQIBS incidents; green builds resolve them

How it works

Travis CI
Alert fires
A build fails.
Travis CI
Sends a webhook
An after_failure step posts JSON with curl.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
failed opens it, passed 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

  1. In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
  2. Add a filter with these values (there is no built-in Travis CI template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "result" failed Opens an incident.
Resolve "result" passed Resolves the open incident.
Match "key" Repository and branch: ties the green build to the failure.
Title from "title" Becomes the incident title.
Description from "url" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Travis CI's built-in webhook notifications post form data with the JSON inside a payload parameter, which SQIBS filters cannot read. The curl steps below send clean JSON instead.

Not sure of a key? Send one test message first (step below), then build the filter from the real payload.

Find the right key with the JSON key creator
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 your token to Travis CI

In the repository's More options > Settings > Environment Variables, add SQIBS_TOKEN with your SQIBS token. Leave Display value in build log off. 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: Report the result from .travis.yml

Add these steps. They run after the script phase, so a failing test opens the incident and the next passing build resolves it:

# .travis.yml
after_failure:
  - >-
    curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=travis"
    -H "Authorization: Bearer $SQIBS_TOKEN" -H "Content-Type: application/json"
    -d "{\"key\": \"$TRAVIS_REPO_SLUG/$TRAVIS_BRANCH\", \"result\": \"failed\",
    \"title\": \"Build $TRAVIS_BUILD_NUMBER failed on $TRAVIS_REPO_SLUG ($TRAVIS_BRANCH)\",
    \"url\": \"$TRAVIS_BUILD_WEB_URL\"}"
after_success:
  - >-
    curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=travis"
    -H "Authorization: Bearer $SQIBS_TOKEN" -H "Content-Type: application/json"
    -d "{\"key\": \"$TRAVIS_REPO_SLUG/$TRAVIS_BRANCH\", \"result\": \"passed\"}"

If your build runs several jobs, each job reports; they share the same key, so they keep to one incident.

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.

  1. Push a commit that fails the build.
  2. In SQIBS, a new incident opens, titled with the build number, repository and branch.
  3. Fix the build and push again. The passed message for the same repository and branch 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 .travis.yml steps.

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 the main branch build fails, SQIBS can run a workflow that holds the deployment and collects the failing test report.

Incident opens
Workflow starts
SQIBS runs the automation workflow linked to the filter.
Fixed
Incident resolved
The issue is fixed before anyone has to step in.
Not fixed
Escalated to the engineer
After the waiting time you set, the escalation policy pages on-call as usual.

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:

  1. Select Workflow: choose the automation workflow to run when this filter opens an incident.
  2. If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
  3. 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: