Overview

Insomnia is an API client, not a monitoring tool, so it does not raise alerts of its own. It is a handy way to send test payloads to your SQIBS API endpoint: check that a filter opens and resolves incidents the way you expect before you connect the real tool, or replay a payload copied from the API log.

You need
Insomnia (desktop app or Inso CLI) and a SQIBS API token
Setup time
About 5 minutes
Result
Test payloads open and resolve SQIBS incidents on demand

Step 1: Add a test filter in SQIBS

In SQIBS, open Services, choose a test service, and click Add Or Update API Integration. Add a filter that matches the test body below:

Part Payload JSON key Key value contains What it does
Trigger "status" firing Opens an incident.
Resolve "status" resolved Resolves the open incident.
Match "alert_key" Ties the resolve to the incident it opened.
Title from "summary" Becomes the incident title.

Use a test service whose escalation policy will not page anyone at night.

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: Create the request in Insomnia

  1. In Insomnia, create a request (or a collection named Callgoose SQIBS) with method POST and your SQIBS endpoint as the URL:
https://<your-endpoint>/sqibs-api/v1/process?from=insomnia&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. To keep the token out of the URL, remove &token= and set Auth to Bearer Token with your token instead. Store it in an environment variable rather than in the request.
  2. Set the body to JSON and paste:
{
  "status": "firing",
  "alert_key": "test-web-01-cpu",
  "summary": "Test alert from Insomnia",
  "severity": "critical"
}
  1. Click Send. A 200 response means SQIBS accepted the payload.

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. Send the request. In SQIBS, a new incident opens titled Test alert from Insomnia.
  2. Change "status" to "resolved" and send again. SQIBS resolves the incident.
  3. To test a real tool's format, paste a payload from that tool's documentation (or from the API log) into the body and adjust the filter until it matches.

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 request URL and token.

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, send a test payload for a known issue and check that SQIBS starts the right workflow before you rely on it in production.

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: