Overview
Send Splunk Enterprise Security detections to Callgoose SQIBS. A correlation search (or any scheduled alert) uses Splunk's webhook action to post its first result to your SQIBS API endpoint. SQIBS opens an incident for each alert.
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 Splunk Enterprise Security template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "search_name" |
Opens an incident. | |
| Title from | "search_name" |
Becomes the incident title. | |
| Description from | "results_link" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Splunk's webhook action sends a fixed JSON format: the search id, a link to the results, the search name, owner, app and the first result row under result. It cannot be templated, so fields such as severity come from your search: add them to the search output (for example | eval severity="high") and they appear under result. Splunk does not send a message when a detection clears, so close these incidents in SQIBS.
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 action to a correlation search
- In Splunk Enterprise Security, go to Configure > Content > Content Management and open the correlation search (or create one).
- Under the alert actions, add Webhook and set its URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=splunkes&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.
- Save the search. The same webhook action works on any scheduled search in Splunk under Edit Alert > Add Actions > Webhook.
- If you run Splunk Cloud, the webhook URL must be on the allow list (Settings > Server settings > Webhook allow list, or ask Splunk support).
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 correlation search against test data that matches it.
- In SQIBS, a new incident opens, titled with the search name. Splunk's payload looks like this (shortened):
{
"result": {
"host": "dc-01.example.com",
"user": "svc-backup",
"count": "42",
"severity": "high"
},
"sid": "scheduler__admin__SplunkEnterpriseSecuritySuite__RMD5a1b2c3d4",
"results_link": "https://splunk.example.com/app/SplunkEnterpriseSecuritySuite/@go?sid=scheduler__admin__SplunkEnterpriseSecuritySuite__RMD5a1b2c3d4",
"search_name": "Access - Excessive Failed Logins - Rule",
"owner": "admin",
"app": "SplunkEnterpriseSecuritySuite"
}
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 Splunk webhook action.
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 correlation search reports excessive failed logins for a service account, SQIBS can run a workflow that disables the account and collects its recent sign-ins for the analyst.
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.