diff --git a/plugins/splunk-on-call/README.md b/plugins/splunk-on-call/README.md index 89fd45adc0..5276d6d2df 100644 --- a/plugins/splunk-on-call/README.md +++ b/plugins/splunk-on-call/README.md @@ -51,6 +51,9 @@ import { In order to be able to perform certain action (create-acknowledge-resolve an action), you need to provide the username of the user making the action. The user supplied must be a valid Splunk On-Call user and a member of your organization. +In addition, you also need to enable the REST Endpoint integration on https://portal.victorops.com/ by going to Integrations > 3rd Party Integrations > REST – Generic. +You can now copy the URL to notify: `/$routing_key` + In `app-config.yaml`: ```yaml @@ -88,6 +91,14 @@ annotations: splunk.com/on-call-team': ``` +### Create the Routing Key + +To be able to use the REST Endpoint seen above, you must have created a routing key with the **same name** as the provided team. + +You can create a new routing key on https://portal.victorops.com/ by going to Settings > Routing Keys. + +You can read [Create & Manage Alert Routing Keys](https://help.victorops.com/knowledge-base/routing-keys/#routing-key-tips-tricks) for further information. + ## Providing the API key and API id In order for the client to make requests to the [Splunk On-Call API](https://portal.victorops.com/public/api-docs.html#/) it needs an [API ID and an API Key](https://help.victorops.com/knowledge-base/api/).