📈 GH Trending Explorer 🎲 Surprise me

← all repos

caronc / apprise

git clone https://github.com/caronc/apprise.git v2.0.1 · 19d ago

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

+6
stars, 24h · #5,474
+~44
stars, 7 days · #4,531
+~190
stars, 30 days · #4,170
18k
★ total · +0% this week
686
forks · 26 open issues

Star history (as recorded here)

2026-10-20 · 17,617 ★ 2026-10-23 · 17,636 ★
LanguagePython
LicenseBSD-2-Clause
Created2017-11-25 (8y ago)
Last pushtoday
Watchers81
OwnerUser

GitHub topics

Links

README excerpt
**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/queue amqp://user:pass@hostname/queue1/queue2 amqps://user:pass@hostname/?exchange=alerts amqps://user:pass@hostname/?version=1.0&to=/queues/name
| Apprise API | apprise:// or apprises:// | (TCP) 80 or 443 | apprise://hostname/Token apprise://:password@hostname/Token apprise://user:pas