Overview

Send Katalon test results to Callgoose SQIBS. After Katalon Runtime Engine runs a suite in your CI job, a short step posts the result to your SQIBS API endpoint. SQIBS opens an incident when the suite fails and resolves it when the next run passes.

You need
Katalon Studio or Katalon Runtime Engine running in CI, and a SQIBS API token
Setup time
About 15 minutes
Result
Failed Katalon suites open SQIBS incidents; passing runs resolve them

How it works

Katalon
Alert fires
A test suite run fails.
Katalon
Sends a webhook
A CI step posts the result as JSON.
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 Katalon template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "status" failed Opens an incident.
Resolve "status" passed Resolves the open incident.
Match "alert_key" One incident per suite.
Title from "summary" Becomes the incident title.
  1. Choose the Priority for these incidents and click Save.

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: Post the result from your CI job

Add a step after the Katalon run that always executes (for example if: always() in GitHub Actions, or when: always in GitLab CI). Save Katalon's exit code in KRE_EXIT and post the result:

# After the test run in your CI job (bash). Katalon Runtime Engine exits non-zero when tests fail.
STATUS=failed; [ "$KRE_EXIT" = "0" ] && STATUS=passed
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=katalon&token=<your-token>" \
  -H 'Content-Type: application/json' \
  -d "{\"status\": \"$STATUS\", \"suite\": \"Regression\", \"alert_key\": \"katalon-regression\", \"summary\": \"Katalon Regression suite $STATUS\", \"build_url\": \"$CI_JOB_URL\"}"

Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens. Keep the token in a CI secret, not in the pipeline file.

Use a different alert_key per suite, so each suite has its own 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.

  1. Run the suite with a test case that is known to fail.
  2. In SQIBS, a new incident opens, titled Katalon Regression suite failed.
  3. Fix the test and run again. The step sends passed with the same alert_key, 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 CI step.

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 smoke suite fails after a deployment, SQIBS can run a workflow that rolls the release back to the last good 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: