PagerDuty Notifications

Overview

• Source: https://www.pagerduty.com
• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Body: 32768

Account Setup

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.

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

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"