caronc /apprise

Apprise - Push Notifications that work with just about every platform!

★ 17,771⑂ 700👁 75⑃ 1,010● 742▤ 69
PythonBSD-2-ClauseCreated 2017-11-25hub.docker.com/r/caronc/apprise
Download: Apprise v2.2.0Apprise-2.2.0 ↓2.2.02026-11-08
+6
Daily
17,771
stars
700
forks
75
watchers
1,010
prs
742
issues
69
releases

README

!Apprise Logo



ap·prise / verb
To inform or tell (someone). To make one aware of something.


Apprise allows you to send a notification to almost all of the most popular notification services available to us today such as: Telegram, Discord, Slack, Amazon SNS, Gotify, etc.

 One notification library to rule them all.
 A common and intuitive notification syntax.
 Supports the handling of images and attachments (_to the notification services that will accept them_).
 It's incredibly lightweight.
 Amazing response times because all messages sent asynchronously.

Developers who wish to provide a notification service no longer need to research each and every one out there. They no longer need to try to adapt to the new ones that comeout thereafter. They just need to include this one library and then they can immediately gain access to almost all of the notifications services available to us today.

System Administrators and DevOps who wish to send a notification now no longer need to find the right tool for the job. Everything is already wrapped and supported within the apprise command line tool (CLI) that ships with this product.










Visit the Official Documentation site for more information on Apprise.

 How It Works

Apprise provides one consistent URL format and notification interface for your apps, automation, and infrastructure. Use the CLI or core library directly, or relay through Apprise API, to deliver notifications to a very large amount of supported services.



 Table of Contents

 Supported Notifications
   Productivity Based Notifications
   SMS Notifications
   Desktop Notifications
   Email Notifications
   Custom Notifications
 Installation
 Command Line Usage
   Configuration Files
   File Attachments
   Loading Custom Notifications/Hooks
   Environment Variables
 Developer API Usage
   Configuration Files
   File Attachments
   Loading Custom Notifications/Hooks
 Persistent Storage
 More Supported Links and Documentation


 Supported Notifications

The section identifies all of the services supported by this library. Check out the wiki for more information on the supported modules here.

 Productivity Based Notifications

The table below identifies the services this tool supports and some example service URLs you need to use in order to take advantage of it. Click on any of the services listed below to get more details on how you can configure Apprise to access them. If you're having trouble constructing your own URL; try our Apprise URL Builder out.

| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| AMQP | amqp:// or amqps:// | (TCP) 5672 or 5671 | amqp://hostname/queueamqp://user:pass@hostname/queue1/queue2amqps://user:pass@hostname/?exchange=alertsamqps://user:pass@hostname/?version=1.0&to=/queues/name
| Apprise API  | apprise:// or apprises:// | (TCP) 80 or 443 | apprise://hostname/Tokenapprise://:password@hostname/Tokenapprise:/

Top issues

Discussions

Latest release

Apprise v2.2.0 v2.2.0 2026-11-08
What's Changed
This release has a few bugfixes, but introuces a slew of (12) new services bringing the total supported services up to 183. The foundation of the Apprise library has now made it very easy to just scan missing service's upstream APIs and add them to our catalog.  There are so many examples now to use as reference. A big kudos to @LuisFigueroaG for all of your contributions for the last 2 releases; I really appeciate it!

Note: There is a security fix in this release: GHSA-cfp4-m43r-v9q4

  :mega: New Notification Services
 Add Groundmail notification support (groundmail://)

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON