Overview

Send Harness events to Callgoose SQIBS. Pipeline notifications post pipeline events to your SQIBS API endpoint, and Harness Code webhooks can send branch, tag and pull request events. SQIBS opens an incident when a pipeline fails and resolves it when the pipeline next succeeds.

You need
A Harness project where you can edit pipelines, and a SQIBS API token
Setup time
About 10 minutes
Result
Failed pipelines open SQIBS incidents; successful runs resolve them

How it works

Harness
Alert fires
A pipeline run fails.
Harness
Sends a webhook
A pipeline notification posts JSON to the webhook.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
PipelineFailed opens it, PipelineSuccess 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. In Select Integration Template, choose the Harness template that fits the alerts you send. Each fills in its own filter values:

Harness - Pipeline Event

Part Payload JSON key Key value contains What it does
Trigger "eventData"."eventType" pipelinefailed Opens an incident.
Resolve "eventData"."eventType" pipelinesuccess Resolves the open incident.
Match "eventData"."planExecutionId" Ties the resolve message to the incident it opened.
Title from "eventData"."eventType" Becomes the incident title.
Description from "eventData"."errorMessage" Becomes the incident description.

Harness - Branch Events

Part Payload JSON key Key value contains What it does
Trigger "trigger" branch_created Opens an incident.
Title from "trigger" Becomes the incident title.
Description from "ref" Becomes the incident description.

Harness - Tag Events

Part Payload JSON key Key value contains What it does
Trigger "trigger" tag_created Opens an incident.
Title from "trigger" Becomes the incident title.
Description from "ref" Becomes the incident description.

Harness - Pull Request Event

Part Payload JSON key Key value contains What it does
Trigger "pull_req"."state" open Opens an incident.
Resolve "pull_req"."state" merged Resolves the open incident.
Match "pull_req"."pr_url" Ties the resolve message to the incident it opened.
Title from "trigger" Becomes the incident title.
Description from "pull_req"."description" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Most teams only need Pipeline Event. It matches on "eventData"."planExecutionId", which is new for every run, so a later successful run never resolves the failed one. Change Map incident with (trigger and resolve) to "eventData"."pipelineIdentifier".

The template is a starting point, not a lock-in: every value stays visible and you can change it.

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 a webhook notification to the pipeline

  1. In Harness, open the pipeline and click Notify (pipeline notification rules). Add a rule.
  2. Give it a name and choose the pipeline events: Pipeline Failed and Pipeline Success (so incidents resolve).
  3. Set the channel type to Webhook and enter your SQIBS endpoint as the URL:
https://<your-endpoint>/sqibs-api/v1/process?from=harness&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.

  1. Click Test, then save the rule and the pipeline.

Step 3: Send Harness Code repository events (optional)

If you host code in Harness Code, open the repository's Settings > Webhooks, add a webhook with the same URL, and choose branch, tag or pull request events. Use the matching SQIBS template for each.

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. Run the pipeline in a way that fails, for example with a step that exits with an error.
  2. In SQIBS, a new incident opens, described with the error message. Harness's payload looks like this (shortened):
{
  "eventData": {
    "pipelineIdentifier": "deploy_prod",
    "pipelineName": "Deploy to production",
    "planExecutionId": "zvWg6tYpQk",
    "eventType": "PipelineFailed",
    "nodeStatus": "failed",
    "errorMessage": "Step 'Rollout' failed: deployment timed out",
    "executionUrl": "https://app.harness.io/ng/account/abc/cd/orgs/default/projects/shop/pipelines/deploy_prod/executions/zvWg6tYpQk/pipeline"
  }
}
  1. Fix the cause and run the pipeline again. When Harness sends PipelineSuccess for the same pipeline, 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 Harness 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 deployment pipeline fails, SQIBS can run a workflow that checks the cluster and rolls the service back to the previous version.

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: