Overview
Send Postman events to Callgoose SQIBS. Postman's webhook integrations can post monitor run results, team activity and collection backups to your SQIBS API endpoint. Most teams use monitor results, so a failing API test becomes an incident.
How it works
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.
- In Select Integration Template, choose the Postman template that fits the alerts you send. Each fills in its own filter values:
Postman API Platform - Post Monitor Results
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "metrics" |
(anything) | Opens an incident. |
| Title from | "monitor_name" |
Becomes the incident title. |
Postman API Platform - Post Team Activiy
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "action" |
(anything) | Opens an incident. |
| Title from | "model_name" |
Becomes the incident title. | |
| Description from | "message" |
Becomes the incident description. |
Postman API Platform - Backup a Collection
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "collection"."item" |
(anything) | Opens an incident. |
| Title from | "collection"."info"."name" |
Becomes the incident title. | |
| Description from | "collection"."info"."description" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Post Monitor Results opens an incident for every run, passing runs included, because the payload has no pass or fail field to match on. Use it for monitors where any run is worth a look, or send only failures to SQIBS by calling the SQIBS API from a test script in the collection. The other two templates are for audit-style events, not alerts.
The template is a starting point, not a lock-in: every value stays visible and you can change it.
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 integration in Postman
- In Postman, open Integrations, choose Webhooks, and click Add Integration next to Post monitoring results.
- Enter a nickname, choose the workspace and the monitor.
- In the webhook URL, enter your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=postman&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.
- Click Add Integration.
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.
- Run the monitor manually.
- In SQIBS, a new incident opens, titled with the monitor name. The payload looks like this (shortened):
{
"collection_name": "Shop API checks",
"monitor_name": "Shop API every 5 min",
"environment_name": "Production",
"metrics": {
"errorCount": 0,
"failedTestCount": 1,
"passedTestCount": 11,
"requestCount": 12,
"responseLatency": 121
}
}
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 Postman integration.
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 Postman monitor finds the orders API failing, SQIBS can run a workflow that restarts the orders service and reruns a health check.
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.