github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity
Page: Home
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_chanify 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_jira 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
148 Home
Chris Caron edited this page 2025-01-18 14:30:57 -05:00
Table of Contents

Introduction

Apprise lets you send notifications to a large number of support notification services. The lightweight framework can be easily integrated into an of your python applications. Or you can simply send notifications right from the command line.

It's primary design was to eliminate the inconsistencies in usage from one notification service to another. By harnessing a simple URL string, you can drive any of the 100+ supported services.

Notification Services:

All of the notification services supported by Apprise can be found in this section.

Legend

  • ๐Ÿ“š : Supports File Attachments
  • ๐Ÿ“ฒ : SMS Based Services

Detailed instructions on how to connect your notification service(s) up with Apprise can be acquired by clicking on the appropriate link(s) below:

  1. Africas Talking
  2. Apprise API ๐Ÿ“š
  3. Automated Packet Reporting System (APRS)
  4. AWS SES ๐Ÿ“š
  5. AWS SNS ๐Ÿ“ฒ
  6. Bark
  7. BulkSMS ๐Ÿ“ฒ
  8. BulkVS ๐Ÿ“ฒ
  9. Burst SMS ๐Ÿ“ฒ
  10. Chanify
  11. ClickSend ๐Ÿ“ฒ
  12. DAPNET
  13. DingTalk ๐Ÿ“ฒ
  14. Discord ๐Ÿ“š
  15. D7 Networks ๐Ÿ“ฒ
  16. E-Mail ๐Ÿ“š
  17. Emby
  18. Enigma2 Devices
  19. FCM - (Google) Firebase Cloud Messaging
  20. Feishu
  21. Flock
  22. Free-Mobile
  23. Google Chat
  24. Gotify
  25. Growl
  26. Guilded ๐Ÿ“š
  27. Home Assistant
  28. httpSMS ๐Ÿ“ฒ
  29. IFTTT
  30. Jira
  31. Join
  32. Kavenegar ๐Ÿ“ฒ
  33. KODI
  34. Kumulos
  35. LaMetric Time/Clock
  36. Line
  37. LunaSea
  38. Mastodon ๐Ÿ“š
  39. Mailgun ๐Ÿ“š
  40. Matrix ๐Ÿ“š
  41. Mattermost
  42. MessageBird ๐Ÿ“ฒ
  43. Microsoft Power Automate / Workflow (MSTeams)
  44. Microsoft Teams
  45. Misskey
  46. MQTT
  47. MSG91 ๐Ÿ“ฒ
  48. Nextcloud Messaging
  49. Nextcloud Talk
  50. Ntfy ๐Ÿ“š
  51. Notica
  52. Notifiarr
  53. Notifico
  54. Office 365
  55. OneSignal
  56. Opsgenie
  57. PagerDuty
  58. Pagertree
  59. Parse Platform
  60. Plivo ๐Ÿ“ฒ
  61. Popcorn Notify
  62. Prowl
  63. PushBullet ๐Ÿ“š
  64. PushDeer
  65. Pushed
  66. Pushjet
  67. PushMe
  68. Pushover ๐Ÿ“š
  69. PushSafer ๐Ÿ“š
  70. Pushy
  71. Reddit
  72. Revolt
  73. Rocket.Chat
  74. RSyslog (Remote Syslog)
  75. Ryver
  76. SendGrid ๐Ÿ“š
  77. ServerChan
  78. Seven ๐Ÿ“ฒ
  79. Sociรฉtรฉ Franรงaise du Radiotรฉlรฉphone (SFR)
  80. SimplePush
  81. Sinch
  82. Signal (API)
  83. Slack ๐Ÿ“š
  84. SMSEagle ๐Ÿ“ฒ ๐Ÿ“š
  85. SMS Manager ๐Ÿ“ฒ
  86. SMTP2Go ๐Ÿ“š
  87. SparkPost ๐Ÿ“š
  88. Splunk (VictorOps) On Call
  89. Streamlabs
  90. Synology
  91. Syslog
  92. Techulus Push
  93. Telegram ๐Ÿ“š
  94. Threema Gateway
  95. Twilio ๐Ÿ“ฒ
  96. Twist
  97. Twitter ๐Ÿ“š
  98. Voip.ms
  99. Vonage ๐Ÿ“ฒ
  100. XBMC
  101. Webex Teams
  102. WeCom Bot
  103. WhatsApp
  104. WxPusher
  105. Zulip

Custom Notification Services

The following are just some general notification services you can configure to have posted to any website of your choice. From there you can decide what actions you want to take.

  1. FORM ๐Ÿ“š
  2. JSON ๐Ÿ“š
  3. XML ๐Ÿ“š

Desktop Notification Services

The following services work locally on the same PC they're ran on.

  1. Linux Notifications:
    1. Gnome
    2. Qt
    3. DBus
  2. MacOS X Notifications
  3. Windows Notifications

Configuration

Configuration can be retrieved via a flat file on your local system or from a remote server via the http(s) protocol. You can learn more about this here:

The following configuration formats are supported:

Installation

Apprise can be installed as easy as:

pip install apprise

Other

Quick Links: