diff --git a/zerver/webhooks/splunk/doc.html b/zerver/webhooks/splunk/doc.html deleted file mode 100644 index ac31d9d63d..0000000000 --- a/zerver/webhooks/splunk/doc.html +++ /dev/null @@ -1,56 +0,0 @@ -
- See your Splunk Search alerts in Zulip! -
-
- First, create the stream you'd like to use for Splunk notifications,
- and subscribe all interested parties to this stream. We recommend the
- stream name splunk
, although you may choose another stream
- if you prefer.
-
- Next, in the Splunk search app, execute the search you'd like to alert on - and then save it as an alert: -
- -- -
- -- Name and configure your search in the "Settings" and "Trigger Conditions" - sections of the "Save As Alert" dialog box. In the "Trigger Actions" section, - click "Add Actions" and select "Webhook" to add a webhook action. Put the - Zulip Splunk webhook URL and your API key in the "URL" field, along with - your desired stream and (optional) topic name. If you do not specify a stream, - your messages will use the default stream `splunk`. If you do not specify a topic, - the name of the search is used (truncated to fit if needed.) -
- -
- Example:
-{{ external_api_uri_subdomain }}/v1/external/splunk?api_key=abcde&stream=splunk&topic=alerts
-
- When you are done, it should look like this: -
- -- -
- -- Click Save to save the alert. You can create as many searches with alert - actions as you like, with whatever stream and topic you choose. Update your - webhook URL as appropriate for each one, and make sure the stream exists. -
- -
- Congratulations! You're done!
When your search triggers an
- alert, you'll see a notification like this:
-
- -
diff --git a/zerver/webhooks/splunk/doc.md b/zerver/webhooks/splunk/doc.md new file mode 100644 index 0000000000..0216fb9058 --- /dev/null +++ b/zerver/webhooks/splunk/doc.md @@ -0,0 +1,36 @@ +See your Splunk Search alerts in Zulip! + +{!create-stream.md!} + +{!create-bot-construct-url.md!} + +{!append-topic.md!} + +Next, in the Splunk search app, execute the search you'd like to be +alerted on and then save it as an alert: + +![](/static/images/integrations/splunk/splunk_save_as_alert.png) + +Name and configure your search in the **Settings** and **Trigger Conditions** +sections of the **Save As Alert** dialog box. + +In the **Trigger Actions** section, click **Add Actions** and select +**Webhook** to add a webhook action. Put the Zulip Splunk webhook URL +we created earlier. + +If you do not specify a stream in the URL, your messages will use +the default stream `splunk`. If you do not specify a topic, +the name of the search is used (truncated to fit if needed.) + +When you are done, it should look like this: + +![](/static/images/integrations/splunk/splunk_configure_url.png) + +Click **Save** to save the alert. You can create as many searches with +alert actions as you like, with whatever stream and topic you choose. +Update your webhook URL as appropriate for each one, and make sure the +stream exists. + +{!congrats.md!} + +![](/static/images/integrations/splunk/splunk_message.png)