Skip to content
Kellerman81 edited this page Dec 21, 2025 · 2 revisions

Notification Configuration

Notifications allow you to receive alerts when media is downloaded, added, or upgraded. Multiple notification services are supported.

General Parameters

All notifications require these parameters:

  • name: Unique identifier for the notification service
  • type: Notification service type
  • enabled: Enable or disable this notification (true/false - not shown in examples but supported)

Supported Notification Types

  1. CSV - Log to CSV file
  2. Pushover - Mobile push notifications
  3. Gotify - Self-hosted notification server
  4. Pushbullet - Cross-device push notifications
  5. Apprise - Universal notification API (supports 80+ services including Discord, Slack, Telegram)

CSV (File Logging)

Logs notification events to a CSV file for record-keeping or integration with other tools.

Parameters:

  • output_to: Path to the CSV file (absolute or relative to executable)

Example:

[[notification]]
name = "csv_log"
type = "csv"
output_to = "/var/log/media_downloads.csv"

CSV Format: The CSV file will contain columns for timestamp, media title, event type, quality, and other metadata.

Pushover

Sends push notifications to your mobile devices via Pushover.

Parameters:

  • apikey: Your Pushover application API key
  • recipient: Pushover user key or group key

Example:

[[notification]]
name = "pushover"
type = "pushover"
apikey = "your_app_api_key"
recipient = "your_user_key"

Rate Limits:

  • Approximately 300 calls per hour
  • 10,000 calls per month (conservative limit)

Setup:

  1. Create an account at https://pushover.net
  2. Create an application to get your API key
  3. Find your user key in your account settings

Gotify

Sends notifications to a self-hosted Gotify server.

Parameters:

  • apikey: Gotify application token
  • server_url: URL of your Gotify server

Example:

[[notification]]
name = "gotify"
type = "gotify"
apikey = "your_gotify_app_token"
server_url = "https://gotify.example.com"

Rate Limits:

  • 1000 calls per hour (self-hosted, generous limit)

Setup:

  1. Install Gotify server (self-hosted)
  2. Create an application in Gotify to get a token
  3. Use the application token as the apikey

Pushbullet

Sends notifications across devices using Pushbullet.

Parameters:

  • apikey: Pushbullet access token

Example:

[[notification]]
name = "pushbullet"
type = "pushbullet"
apikey = "your_pushbullet_access_token"

Setup:

  1. Create an account at https://www.pushbullet.com
  2. Generate an access token from Settings → Account
  3. Install Pushbullet app on your devices

Apprise

Universal notification gateway supporting 80+ services including Discord, Slack, Telegram, Email, and many more.

Parameters:

  • server_url: URL of your Apprise server (if using self-hosted Apprise API)
  • apprise_urls: Comma-separated list of Apprise notification URLs

Example (Self-Hosted Apprise):

[[notification]]
name = "apprise"
type = "apprise"
server_url = "http://localhost:8000"
apprise_urls = "discord://webhook_id/webhook_token,slack://token,tgram://bot_token/chat_id"

Example (Direct URLs, no server):

[[notification]]
name = "apprise"
type = "apprise"
server_url = ""
apprise_urls = "discord://webhook_id/webhook_token"

Supported Services (via Apprise URLs):

  • Discord: discord://webhook_id/webhook_token
  • Slack: slack://token
  • Telegram: tgram://bot_token/chat_id
  • Email: mailto://user:password@domain
  • Microsoft Teams: msteams://token_a/token_b/token_c
  • And 75+ more services

Setup:

  1. (Optional) Install Apprise API server for centralized management
  2. Generate notification URLs for your services (see Apprise documentation)
  3. Combine multiple URLs with commas for multi-service notifications

Apprise Documentation: https://github.com/caronc/apprise

Notification Events

Notifications can be triggered on these events (configured in media group settings):

  • added_download: When media is successfully downloaded
  • added_data: When media files are manually added without replacing existing files
  • upgraded_data: When media files are upgraded/replaced with higher quality

Message Configuration

Notification messages are configured in your media group settings, not in the notification configuration itself.

Parameters (in media group config):

  • title: Notification title template
  • message: Notification message body template
  • replaced_prefix: Text prefix for upgrade/replacement notifications

Template Variables: You can use variables in title and message templates:

  • {title} - Media title
  • {year} - Release year
  • {quality} - Quality profile name
  • {resolution} - Video resolution
  • {codec} - Video codec
  • {audio} - Audio format

Example (in media group config):

[media.notification.added_download]
template_notification = "pushover"
title = "Downloaded: {title}"
message = "Quality: {quality} - {resolution} {codec}"

[media.notification.upgraded_data]
template_notification = "pushover"
title = "Upgraded: {title}"
message = "New Quality: {quality} - Old file replaced"
replaced_prefix = "[UPGRADE]"

Multiple Notifications

You can configure multiple notification services and use different services for different media groups or event types.

Example:

# Mobile notifications for important events
[[notification]]
name = "phone_pushover"
type = "pushover"
apikey = "app_key"
recipient = "user_key"

# CSV log for all events
[[notification]]
name = "complete_log"
type = "csv"
output_to = "/logs/downloads.csv"

# Discord notifications for community
[[notification]]
name = "discord"
type = "apprise"
apprise_urls = "discord://webhook_id/webhook_token"

Then in your media group, you can use different notifications for different events:

[media.notification.added_download]
template_notification = "discord"  # Notify Discord on new downloads

[media.notification.upgraded_data]
template_notification = "phone_pushover"  # Push to phone on upgrades

Tips

  1. Test Notifications: Send a test notification after configuration to verify setup
  2. Rate Limits: Be aware of API rate limits, especially for free tiers
  3. Multiple Services: Use CSV logging alongside push notifications for complete records
  4. Apprise Flexibility: Use Apprise for services not directly supported
  5. Event Filtering: Configure different notifications for different event types
  6. Self-Hosted: Consider Gotify or Apprise API for self-hosted, private notifications

Clone this wiki locally