apprise

extern/apprise

Fork 0

mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00

Table of Contents

PagerDuty Notifications

Syntax
Parameter Breakdown

Example

Custom Details

PagerDuty Notifications

Source: https://www.pagerduty.com
Icon Support: No
Attachment Support: Yes
Message Format: Text
Message Limit: 32768 Characters per message

You need to have an account with PagerDuty 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.
severity	No	The notification severity is otherwise detected on it's own, however if you wish to force a specific mode always, you can do so by providing this as part of the URL. Possible values are: `info`, `warning`, `critical`, and `error`.

Example

Send a Pager Duty trigger to our source node01.local and the component drive_sda


# Assuming our {integration_key} is A1BRTD4JD
# Assuming our {api_key} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {source} is node01.local
# Assuming our {component} is drive_sda
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "pagerduty://A1BRTD4JD@TIiajkdnlazkcOXrIdevi7F/node01.local/drive_sda/"

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.

# Below would pass along in the `custom_details` payload of the API
#    "disk_space_left": "145GB"
#
# Assuming our {integration_key} is abc123
# Assuming our {api_key} 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 {integration_key} is abc123
# Assuming our {api_key} 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"

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface