Skip to content

Splunk Webhook

Splunk Webhook sends Splunk Alert results directly to ASP and writes them into Redis Stream for Module consumption.

Endpoint

text
POST /api/webhook/splunk/

Replace the domain with your ASP backend address, for example:

text
https://asp.example.com/api/webhook/splunk/

Create an Alert in Splunk

Write SPL and save it as an Alert.

Splunk Alert configuration

Recommended configuration:

  • Set Cron Expression / Time Range according to detection frequency, for example run every 5 minutes and search the previous 5 minutes.
  • Select For each result as the trigger so each result is sent as an independent Webhook request.
  • Set Webhook URL to https://<asp-host>/api/webhook/splunk/.
  • Keep the Alert name consistent with the target Module STREAM_NAME.

Payload requirements

ASP's Splunk Webhook reads these fields:

FieldDescription
search_nameSplunk Alert name. It is used as the Redis Stream name.
resultSingle alert result written to Stream for Module processing.
sidOptional Splunk search job ID.
appOptional Splunk app.
ownerOptional Splunk owner.
results_linkOptional link back to Splunk results.

Verification

After the Alert triggers, Splunk sends a request to ASP Webhook. After ASP returns success, the result is written to the Redis Stream named by search_name.

Splunk Webhook trigger

View written messages in Redis or Custom Console to confirm that a Module can consume them.

Splunk Stream message

Recommendations

  • Keep SPL output fields stable to avoid frequent Module mapping changes.
  • Keep Alert name consistent with the Stream name expected by the backend Module.
  • Output stable correlation fields for the same event type so Correlation UID can be generated later.
  • For complete examples, see Custom Module Examples.