Opsgenie Notifications

Overview

• Source: https://www.opsgenie.com
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 15000

Account Setup

1. Visit https://www.opsgenie.com to create your account.
2. Generate your Integration API Key

Note: You must generate an Integration API Key; this is not to be confused with the Opsgenie Management API Key.

Syntax

Valid syntax is as follows:

• opsgenie://{apikey}/
• opsgenie://{apikey}/@{user}
• opsgenie://{apikey}/@{user1}/@{user2}/@{userN}
• opsgenie://{apikey}/*{schedule}
• opsgenie://{apikey}/*{schedule1}}/*{schedule2}/*{scheduleN}
• opsgenie://{apikey}/^{escalation}
• opsgenie://{apikey}/^{escalation1}/^{escalation2}/^{escalationN}
• opsgenie://{apikey}/#{team}
• opsgenie://{apikey}/#{team1}/#{team2}/#{teamN}

Note

If no prefix character is specified, then the target is presumed to be a user (an @ symbol is presumed to be in front of it).

You can also mix/match the targets:

• opsgenie://{apikey}/@{user}/#{team}/*{schedule}/^{escalation}

Parameter Breakdown

Variable	Required	Description
apikey	Yes	This is the API Key associated with your Opsgenie account.
user	No	The user you wish to notify; this can be a username, email, or uuid4. This is the assumed default target type to notify, but it is advised you prefix all users with a @ symbol to eliminate any ambiguity.
team	No	The team you wish to notify; this can be the team name itself, or or uuid4 associated with it. Note: Teams must be prefixed with a # symbol.
schedule	No	The schedule you wish to notify; this can be the schedule name itself, or or uuid4 associated with it. Note: Schedules must be prefixed with a * symbol.
escalation	No	The escalation you wish to notify; this can be the escalation name itself, or or uuid4 associated with it. **Note:**Escalations must be prefixed with a ^ symbol.
region	No	The 2 character region code. By default this is set to us if not specified. Europeans must set this to eu to work correctly.
batch	No	Set it to Yes if you want all identified targets to be notified notified in batches (instead of individually). By default this is set to No.
tags	No	A comma separated list of tags you can associate with your Opsgenie message
priority	No	The priority to associate with the message. It is on a scale between 1 and 5. The default value is 3 if not specified.
alias	No	The alias to associate with the message.
entity	No	The entity to associate with the message.

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 Opsgenie notification to all devices associated with a project:

# Assuming our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   opsgenie://a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty

Include Details (Key/Value Pairs)

Opsgenie allows you to provide details composed of key/value pairs you can set with messages. This can be accomplished by just sticking a plus symbol (+) in front of any parameter you specify on your URL string.

# Below would set the key/value pair of foo=bar:
# Assuming our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "opsgenie://a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty/?+foo=bar"

# Multiple key/value pairs just require more entries:
# Below would set the key/value pairs of:
#    foo=bar
#    apprise=awesome
#
# Assuming our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "opsgenie://a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty/?+foo=bar&+apprise=awesome"