diff --git a/Notify_pagerduty.md b/Notify_pagerduty.md new file mode 100644 index 0000000..b2f9296 --- /dev/null +++ b/Notify_pagerduty.md @@ -0,0 +1,55 @@ +## PagerDuty Notifications +* **Source**: https://pushover.net/ +* **Icon Support**: No +* **Attachment Support**: Yes +* **Message Format**: Text +* **Message Limit**: 32768 Characters per message + +You need to have an account with [PagerDuty](https://www.pagerduty.com) and generate/access your API key. + +From there you can define an API V2 Integration. + +### Syntax +Valid syntax is as follows: +* `pagerduty://{integration_key}@{api_key}` +* `pagerduty://{integration_key}@{api_key}/{source}` +* `pagerduty://{integration_key}@{api_key}/{source}/{component}` + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| integration_key | Yes | This is provided to you on the Events API V2 integration's detail page. This can also be referred to as a Routing Key. +| api_key | Yes | The API Key associated with your setup +| group | No | Provide a group (string) as part of the payload +| class | No | Provide a class (string) as part of the payload +| region | No | By default this takes on the value of **us**. But you can optionally set it to **eu** as well. +| source | No | Provide a source (string) as part of the payload; the default is **Apprise** if one isn't specified. +| component | No | Provide a component (string) as part of the payload; the default is **Notification** if one isn't specified. +| click | No | Provide a clickable URL to associate with the notice. +| image | No | Associate the notification status via a represented icon. You can set this value to `no` if you do not want this to occur. + +### Custom Details +You can provide custom details as part of the payload as well. This can be accomplished by just sticking a plus symbol (**+**) in front of any parameter you specify on your URL string. +```bash +# Below would pass along in the `custom_details` payload of the API +# "disk_space_left": "145GB" +# +# Assuming our {integrationkey} is abc123 +# Assuming our {apikey} is 98754 +# Assuming our {source} is node01.local +# Assuming our {component} is drive_sda +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + "pagerduty://abc123@98754/node01.local/drive_sda/?+disk_space_left=145GB" + +# Multiple details just require more entries defined: +# Below would set the custom details to: +# "disk_space_left": "145GB" +# "disk_space_total": "500GB" +# +# Assuming our {integrationkey} is abc123 +# Assuming our {apikey} is 98754 +# Assuming our {source} is node01.local +# Assuming our {component} is drive_sda +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + "pagerduty://abc123@98754/node01.local/drive_sda/?+disk_space_left=145GB&"+disk_space_total=500GB" +``` \ No newline at end of file