Splunk On-Call


Schemes	`splunk://`, `victorops://`
Cargo feature	`service-splunk`
Service	https://www.splunk.com/en_us/products/on-call.html
Body formats	`text` (first is the default)
Attachments	no
Title length	60 characters
Body length	400 characters
Body lines	unlimited
Request throttle	none
Vendor URLs accepted	yes

URL formats

{schema}://{routing_key}@{apikey}
{schema}://{routing_key}@{apikey}/{entity_id}

{schema} is one of splunk://, victorops://.

URL tokens

Token	Meaning	Type	Required	Notes
`{apikey}`	API Key	string	yes	secret; must match `^[A-Z0-9_-]+$`
`{entity_id}`	Entity ID	string	no
`{routing_key}`	Target Routing Key	string	yes	must match `^[A-Z0-9_-]+$`

Query parameters

Parameter	Meaning	Type	Default	Notes
`action`	Action	choice	`map`	one of `map`, `info`, `acknowledgement`, `warning`, `recovery`, `resolve`, `critical`
`apikey`	API Key	string		sets `{apikey}`
`entity_id`	Entity ID	string		sets `{entity_id}`
`routing_key`	Target Routing Key	string		sets `{routing_key}`; also `route`

Prefixed parameters:

:name=value: Action Mapping

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Accepted URLs (tokens are fake):

splunk://db@apikey
splunk://route@abc123/a/b/c/
splunk://route@abc123/entity_id
https://alert.victorops.com/integrations/generic/20131114/alert/apikey/routing_key
splunk://db@apikey?:f=ack
https://alert.victorops.com/integrations/generic/20131114/alert/apikey/routing_key/entity_id?action=crit
splunk://db@apikey?action=recovery
splunk://db@apikey?:warning=critical

Rejected URLs:

splunk://
splunk://:@/
splunk://routekey@%badapi%
splunk://abc123

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'splunk://db@apikey'

Notes

Splunk On-Call / VictorOps (splunk://, victorops://): incidents through the Splunk On-Call REST endpoint.