Apprise

BSD-2-Clause
Platform
Linux macOS Windows Docker
Licence
BSD-2-Clause Open source
Apprise

Apprise is a BSD-licensed Python library and command-line tool that gives a program or a shell script one way to send a notification to almost any service. Instead of writing separate integrations for Telegram, Discord, Slack, Matrix, ntfy, Gotify, an SMTP mailbox or a plain webhook, you describe the destination as a URL — tgram://bot_token/chat_id, discord://webhook_id/webhook_token, mailto://user:password@gmail.com — and Apprise parses it and delivers the message.

It is the plumbing that saves you from maintaining notification code per provider: the same URL syntax works from Python, from the apprise CLI, or relayed through Apprise API, and each destination stays independent, so adding a second chat channel is one more URL rather than another integration.

Key features

  • One URL per destination — every supported service is addressed by a single standard URL, so the same message can be broadcast to a chat channel, an email address and a webhook in one command.
  • Command-line first — the apprise binary takes a title and a body plus any number of URLs, which makes it usable directly from cron jobs, backup scripts and systemd units.
  • Tag routing — -g / --tag filters which destinations a message goes to, so one saved configuration can serve several workflows (repeated flags OR the tags together, a comma-separated list ANDs them).
  • Attachments and images — files and inline images are delivered to the services that accept them.
  • A library as well as a CLI — the same URL handling is importable from Python, so an application inherits the whole provider list instead of hard-coding one API.
  • Persistent storage — the apprise storage subcommand keeps URLs for reuse, so scripts do not have to carry credentials on the command line.
  • Asynchronous delivery — messages are dispatched asynchronously, so the caller is not held up when many services are notified at once and one of them is slow.

Getting started

Install it from PyPI with pip install apprise, from the Debian and Ubuntu archives as the apprise package (Debian trixie ships 1.9.3-1), or run the published container image. A one-line notification looks like this:

apprise -vv -t "Backup complete" -b "Nightly backup finished in 4m12s" tgram://bot_token/chat_id discord://webhook_id/webhook_token

Python 3.9 or newer is required. Because a destination is just a URL, the same command works whether the target is a hosted chat platform or a self-hosted server such as ntfy.

Who it is for

Apprise suits anyone who wires notifications into automation: a homelab sending backup and alert results to a phone, a developer exposing one notify path across several providers, or a sysadmin who wants alert routing to survive a change of chat platform. It is a delivery library rather than a monitoring product, so it does not decide what is worth alerting on – pair it with whatever produces the events.

Licence

BSD-2-Clause. The project is developed in the open on GitHub by Chris Caron and contributors.

Alternatives

  • ntfy — self-hosted push notification server with its own publisher API; a natural Apprise destination as much as a replacement
  • Gotify — self-hosted push server with a single-provider API, if you only ever need one channel and want the server itself

Explore More Categories

Sign In

Register

Reset Password

Please enter your username or email address, you will receive a link to create a new password via email.