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_notifiarr
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
7 Notify_notifiarr
Chris Caron edited this page 2024-07-28 08:38:31 -04:00
Table of Contents

Notifiarr Notifications

  • Source: https://notifiarr.com
  • Icon Support: No
  • Attachment Support: No
  • Message Format: Text
  • Message Limit: 32768 Characters per message

Account Setup

You need to first set up an account with Notifiarr if you don't have one already. From there you can generate yourself your {api_key}. You will need to use your “global” API key, the integration-specific Notifiarr API keys do not work with Apprise.

Discord Channel IDs

To use Notifiarr, you need your Discord ChannelID. It must be the numeric version of it. Here is some great instructions on how to get it.

In short:

  • Enable Developer Mode by visiting your Discord Settings and going to Appearance.

Pinging Roles, Tags, and Users

The notifiarr message body can contain content such as the following to trigger the appropriate pings

  • user: <@123>
  • role: <@&456>
  • tag: @everyone

Note: that as of this time (2024 Jul 28th), the upstream webhook to Notifiarr only supports 1 user/role in the payload. If you provide more then one, only the first will be passed upstream.

Syntax

Valid syntax is as follows:

  • notifiarr://{api_key}/{channel_id}
  • notifiarr://{api_key}/{channel1_id}/{channel2_id}/{channelN_id}

Parameter Breakdown

Variable Required Description
api_key Yes Your global (not integration-specific) Notifiarr API Key
source No Optionally provide the source of the notification as a descriptive string (you can also use from as an alias to this same variable)
event No Optionally specify the Notifiarr Event ID you want your notification update. If none is specified, then a new notification is generated

Example

Send a discord notification:

# Assuming our {APIKey} is 4174216298
# Assuming our {ChannelID} is 123456789
# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
"notifiarr://4174216298/123456789"

If you have a Discord Event ID you wish to reference, you can do the following:

# Assuming our {APIKey} is 4174216298
# Assuming our {ChannelID} is 123456789
# Assuming our {EventID} is 1234
# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
"notifiarr://4174216298/123456789?event=1234"

Quick Links: