Overview
Send StackHawk application security scan results to Callgoose SQIBS. The StackHawk webhook integration posts each scan event to your SQIBS API endpoint. SQIBS opens an incident for each completed scan, with a link to its findings, so a person reviews it.
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.
- Add a filter with these values (there is no built-in StackHawk template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "scanCompleted"."scan"."status" |
COMPLETED |
Opens an incident. |
| Title from | "scanCompleted"."scan"."application" |
Becomes the incident title. | |
| Description from | "scanCompleted"."scan"."scanURL" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Every completed scan opens an incident; use a low priority for this filter if most scans are clean. To page only on scan problems, send the Scan Errored event too and add a filter on the key it uses (check it with the JSON key creator). StackHawk does not send a resolve, so close the incident when the findings are triaged.
Not sure of a key? Send one test message first (step below), then build the filter from the real payload.
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 the webhook in StackHawk
- The webhook integration must be enabled for your organization; if you do not see it, contact StackHawk support.
- In StackHawk, open the Webhook Integration page and click Add Webhook.
- Enter a name and description, choose the applications under Scan Data For (or All Applications), and under Events choose Scan Completed (and Scan Errored if you want it).
- Enter your SQIBS endpoint as the URL and save:
https://<your-endpoint>/sqibs-api/v1/process?from=stackhawk&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.
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 a scan with
hawk scan. - In SQIBS, a new incident opens when the scan completes. StackHawk's payload looks like this (shortened):
{
"service": "StackHawk",
"scanCompleted": {
"scan": {
"id": "21a4f2da-740b-40d9-9557-696d8aca6a76",
"env": "Development",
"status": "COMPLETED",
"application": "shop-web",
"scanURL": "https://app.stackhawk.com/scans/21a4f2da-740b-40d9-9557-696d8aca6a76"
}
}
}
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 StackHawk webhook.
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 scan completes on a staging build, SQIBS can run a workflow that blocks promotion to production until someone triages the findings.
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.