Skip to main content

Apprise

Apprise is a universal notification library that supports over 80 different notification services.

Configuration

Configure Apprise to send notifications through any of its supported services.

⚙️Mode

Choose how to connect to Apprise:

  • API: Requires an external Apprise API container running. Notifications are sent via HTTP requests to the Apprise server.
  • CLI: Uses the Apprise CLI directly on the host machine. For Docker users, the CLI is pre-installed in the container. Non-Docker users must install Apprise separately.

API Mode

Configure settings for API mode. These settings are used when connecting to an external Apprise API server.

🔗URL

The Apprise server URL where notification requests will be sent.

🔐Key

The key that identifies your Apprise configuration. This corresponds to a configuration defined in your Apprise server.

🏷️Tags

Optionally notify only those tagged accordingly. Use a comma (,) to OR your tags and a space ( ) to AND them. More details on this can be seen in the Apprise documentation.

CLI Mode

Configure settings for CLI mode. These settings are used when invoking the Apprise CLI directly.

📋Service URLs

Add Apprise service URLs that define where notifications will be sent. Each URL corresponds to a specific notification service.

Examples:

  • Discord: discord://webhook_id/token
  • Slack: slack://token_a/token_b/token_c
  • Telegram: tgram://bot_token/chat_id
  • Email: mailto://user:password@gmail.com

For a complete list of supported services and their URL formats, see the Apprise Wiki.