extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_opsgenie
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
5 Notify_opsgenie
Chris Caron edited this page 2021-01-01 21:23:56 -05:00
Table of Contents

Opsgenie Notifications

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

The 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.

Example

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"

Quick Links: