feat(splunk-on-call-plugin): update documentation

Signed-off-by: Remi <remi.d45@gmail.com>
2021-02-25 23:22:53 +01:00
parent 98fb840b4d
commit 14af7ac400
1 changed files with 11 additions and 0 deletions
@@ -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: `<SPLUNK_ON_CALL_REST_ENDPOINT>/$routing_key`
+
 In `app-config.yaml`:

 ```yaml
@@ -88,6 +91,14 @@ annotations:
  splunk.com/on-call-team': <SPLUNK_ON_CALL_TEAM_NAME>
 ```

+### 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/).