Skip to main content

Notifications

qui sends notifications to the Notifiarr API and to Shoutrrr targets. Configure one or more targets in Settings → Notifications and select the events to send.

Setup

  1. Open Settings → Notifications.
  2. Add a target name and URL.
  3. Select the events to send.
  4. Save, then click the send icon (paper plane) on the target card to send a test notification.

Notes:

  • If a qui update adds new events, existing targets keep their saved event list.
  • qui truncates long messages to stay within provider limits.
  • Discord and Notifiarr targets receive rich embeds with fields. Other services receive plain text.

Event types

Event keyDescription
torrent_addedThe client adds a torrent (includes tracker, category, tags, and ETA when available).
torrent_completedA torrent download completes (includes tracker, category, and tags when available).
backup_succeededA backup run completes successfully.
backup_failedA backup run fails.
dir_scan_completedA directory scan run finishes.
dir_scan_failedA directory scan run fails.
orphan_scan_completedAn orphan scan run completes (includes clean runs).
orphan_scan_failedAn orphan scan run fails.
cross_seed_automation_succeededRSS cross-seed automation completes (summary counts and samples).
cross_seed_automation_failedRSS cross-seed automation fails or completes with errors (summary).
cross_seed_search_succeededSeeded search run completes (summary counts and samples).
cross_seed_search_failedSeeded search run fails or cancels (summary).
cross_seed_completion_succeededCompletion search run completes (summary counts and samples).
cross_seed_completion_failedCompletion search run fails.
cross_seed_webhook_succeededWebhook apply adds one or more torrents. No-op checks and applies do not notify.
cross_seed_webhook_failedWebhook check or apply fails.
automations_actions_appliedAutomation rules apply actions (summary counts and samples, only if actions occur).
automations_run_failedAutomation rules fail to run for an instance (system error).

Notifiarr API

If you want output similar to Discord embeds, use the native Notifiarr API scheme:

  • notifiarrapi://apikey
  • Optional override: notifiarrapi://apikey?endpoint=https://notifiarr.com/api/v1/notification/qui

Shoutrrr URLs

Use any Shoutrrr-supported URL scheme. Examples:

  • discord://token@channel
  • notifiarr://apikey
  • slack://token@channel
  • telegram://token@telegram?chats=chat-id
  • gotify://host/token

Notifiarr also accepts optional parameters such as channel and name, for example notifiarr://apikey?name=qui&channel=123456789.

See the Shoutrrr documentation for the full list of services and URL formats: https://github.com/nicholas-fedor/shoutrrr