Skip to main content

​
Setup

Install the Splunk On Call integration from the Courier integrations catalog. You will need your Splunk On Call API key and API ID.
Splunk On Call was formerly known as VictorOps. The API documentation at portal.victorops.com may redirect to Splunk’s current documentation.

​
Profile Requirements

To deliver a message to a recipient over Splunk On Call, you must provide a target object containing the recipient’s type and slug as splunk-on-call in the profile. 
{
  "message": {
    "to": {
      "splunk-on-call": {
        "target": {
          "type": "User",
          "slug": "userSlug"
        }
      }
    }
  }
}

​
Template Requirements

To deliver a message to a recipient over Splunk On Call, you must provide a summary in the notification’s integration settings.

​
Overrides

You can override the API key, API ID, username, URL, and request body. Below is an example of overriding the API key and username via the config override: 
{
  "message": {
    "template": "NOTIFICATION_TEMPLATE_ID",
    "to": {
      "splunk-on-call": {
        "target": {
          "type": "User",
          "slug": "kpryde"
        }
      }
    },
    "providers": {
      "splunk-on-call": {
        "override": {
          "config": {
            "apiKey": "RUNTIME_API_KEY",
            "userName": "RUNTIME_USERNAME"
          }
        }
      }
    }
  }
}