Notifications (Connect)#

Radarr supports pushing notifications to external applications and services.

The main uses cases for this are:

  • Notifying users when media requests have been processed.
  • Alerting administrators to issues with the operation of Radarr (e.g. indexers not working).

Notification connections are defined using a dictionary structure, where the name of the definition becomes the name of the notification connection in Radarr.

radarr:
  settings:
    notifications:
      delete_unmanaged: false
      definitions:
        Email:  # Name of notification connection in Radarr.
          type: email  # Required
          notification_triggers:  # When to send notifications.
            on_grab: true
            on_import: true
            on_upgrade: true
            on_rename: false
            on_movie_added: true
            on_movie_delete: true
            on_movie_file_delete: true
            on_movie_file_delete_for_upgrade: true
            on_health_issue: true
            include_health_warnings: true
            on_health_restored: true
            on_manual_interaction_required: true
            on_application_update: true
          # Connection-specific parameters.
          server: smtp.example.com
          port: 465
          use_encryption: true
          username: radarr
          password: fake-password
          from_address: radarr@example.com
          recipient_addresses:
            - admin@example.com
          # Tags can also be assigned to connections.
          tags:
            - anime-movies
        # Add additional connections here.

Radarr supports pushing notifications to applications for a variety of different conditions. The conditions to notify can be configured using notification triggers.

Note that some connection types only support a subset of these notification triggers. Check each notification connection type for a list of supported triggers.

The following settings determine how Buildarr manages notification connection definitions in Radarr.

delete_unmanaged: bool = False class-attribute instance-attribute #

Automatically delete connections not configured in Buildarr.

Warning

Some notification connection types are not supported by Buildarr, and must be configured manually. Do not enable this option when using such connections.

definitions: Dict[str, Annotated[NotificationType, Field(discriminator='type')]] = {} class-attribute instance-attribute #

Define notification connections as a dictionary under this attribute.

Apprise#

Receive media update and health alert push notifications via an Apprise server.

type: Literal['apprise'] = 'apprise' class-attribute instance-attribute #

Type value associated with this kind of connection.

base_url: AnyHttpUrl instance-attribute #

Apprise server base URL, including http[s]:// and port if needed.

configuration_key: Optional[SecretStr] = None class-attribute instance-attribute #

Configuration key for the Persistent Storage Solution.

Leave empty if Stateless URLs are used.

stateless_urls: Set[AnyHttpUrl] = set() class-attribute instance-attribute #

One or more URLs where notifications should be sent to.

Leave undefined or empty if Persistent Storage is used.

notification_type: AppriseNotificationType = AppriseNotificationType.INFO class-attribute instance-attribute #

The Apprise notification type to classify notifications under.

Values:

  • Info (default)
  • Success
  • Warning
  • Failure
apprise_tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Optionally notify only targets with the defined tags.

username: Optional[str] = None class-attribute instance-attribute #

Basic HTTP auth username for authenticating with Apprise, if required.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Basic HTTP auth password for authenticating with Apprise, if required.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Boxcar#

Receive media update and health alert push notifications via Boxcar.

type: Literal['boxcar'] = 'boxcar' class-attribute instance-attribute #

Type value associated with this kind of connection.

access_token: Password instance-attribute #

Access token for authenticating with Boxcar.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Custom Script#

Execute a local script on the Radarr host (container) when events occur.

type: Literal['custom-script', 'custom_script', 'customscript'] = 'custom-script' class-attribute instance-attribute #

Type value associated with this kind of connection.

path: NonEmptyStr instance-attribute #

Path of the script to execute.

arguments: Optional[str] = None class-attribute instance-attribute #

Arguments to pass to the script, if required.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Discord#

Send media update and health alert messages to a Discord server.

type: Literal['discord'] = 'discord' class-attribute instance-attribute #

Type value associated with this kind of connection.

webhook_url: AnyHttpUrl instance-attribute #

Discord server webhook URL.

username: Optional[str] = None class-attribute instance-attribute #

The username to post as.

If unset, blank or set to None, use the default username set to the webhook URL.

avatar: Optional[str] = None class-attribute instance-attribute #

Change the avatar that is used for messages from this connection.

If unset, blank or set to None, use the default avatar for the user.

host: Optional[str] = None class-attribute instance-attribute #

Override the host name that shows for this notification.

If unset, blank or set to None, use the machine name.

on_grab_fields: Set[OnGrabField] = {OnGrabField.overview, OnGrabField.rating, OnGrabField.genres, OnGrabField.quality, OnGrabField.group, OnGrabField.size, OnGrabField.links, OnGrabField.release, OnGrabField.poster, OnGrabField.fanart, OnGrabField.indexer, OnGrabField.custom_formats, OnGrabField.custom_format_score} class-attribute instance-attribute #

Set the fields that are passed in for this 'on grab' notification. By default, all fields are passed in.

Values:

  • overview
  • rating
  • genres
  • quality
  • group
  • size
  • links
  • release
  • poster
  • fanart
  • indexer
  • custom-formats
  • custom-format-score

Example:

...
  notifications:
    definitions:
      Discord:
        type: discord
        webhook_url: "https://..."
        on_grab_fields:
          - overview
          - quality
          - release
on_import_fields: Set[OnImportField] = {OnImportField.overview, OnImportField.rating, OnImportField.genres, OnImportField.quality, OnImportField.codecs, OnImportField.group, OnImportField.size, OnImportField.languages, OnImportField.subtitles, OnImportField.links, OnImportField.release, OnImportField.poster, OnImportField.fanart} class-attribute instance-attribute #

Set the fields that are passed in for this 'on import' notification. By default, all fields are passed in.

Values:

  • overview
  • rating
  • genres
  • quality
  • codecs
  • group
  • size
  • languages
  • subtitles
  • links
  • release
  • poster
  • fanart

Example:

...
  notifications:
    definitions:
      Discord:
        type: discord
        webhook_url: https://...
        on_import_fields:
          - overview
          - quality
          - release
on_manual_interaction_fields: Set[OnManualInteractionField] = {OnManualInteractionField.overview, OnManualInteractionField.rating, OnManualInteractionField.genres, OnManualInteractionField.quality, OnManualInteractionField.group, OnManualInteractionField.size, OnManualInteractionField.links, OnManualInteractionField.download_title, OnManualInteractionField.poster, OnManualInteractionField.fanart} class-attribute instance-attribute #
tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Email#

Send media update and health alert messages to an email address.

type: Literal['email'] = 'email' class-attribute instance-attribute #

Type value associated with this kind of connection.

server: NonEmptyStr instance-attribute #

Hostname or IP address of the SMTP server to send outbound mail to.

port: Port = 587 class-attribute instance-attribute #

The port number on the SMTP server to use to submit mail.

The default is to use STARTTLS on the standard SMTP submission port.

use_encryption: bool = False class-attribute instance-attribute #

Whether or not to use encryption when sending mail to the SMTP server.

If the port number is set to 465, SMTPS (implicit TLS) will be used. Any other port number will result in STARTTLS being used.

The default is to not require encryption.

username: NonEmptyStr instance-attribute #

SMTP username of the account to send the mail from.

password: Password instance-attribute #

SMTP password of the account to send the mail from.

from_address: NameEmail instance-attribute #

Email address to send the mail as.

RFC-5322 formatted mailbox addresses are also supported, e.g. Radarr <radarr@example.com>.

recipient_addresses: Annotated[List[NameEmail], Field(min_items=1, unique_items=True)] instance-attribute #

List of email addresses to directly address the mail to.

At least one address must be provided.

cc_addresses: Annotated[List[NameEmail], Field(unique_items=True)] = [] class-attribute instance-attribute #

Optional list of email addresses to copy (CC) the mail to.

bcc_addresses: Annotated[List[NameEmail], Field(unique_items=True)] = [] class-attribute instance-attribute #

Optional list of email addresses to blind copy (BCC) the mail to.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Emby / Jellyfin#

Send media update and health alert push notifications to an Emby or Jellyfin media server.

type: Literal['emby', 'jellyfin', 'emby-jellyfin', 'emby_jellyfin', 'embyjellyfin'] = 'emby-jellyfin' class-attribute instance-attribute #

Type values associated with this kind of connection.

It is recommended to use the value representing the actual instance you are using, e.g. for Emby use emby, for Jellyfin use jellyfin.

hostname: NonEmptyStr instance-attribute #

Emby / Jellyfin server hostname.

port: Port = 8096 class-attribute instance-attribute #

Emby / Jellyfin server access port.

use_ssl: bool = False class-attribute instance-attribute #

Connect to the server using HTTPS.

api_key: Password instance-attribute #

API key for authenticating with Emby / Jellyfin.

send_notifications: bool = False class-attribute instance-attribute #

Have the server send notifications to configured providers.

update_library: bool = False class-attribute instance-attribute #

When set to true, update the Emby / Jellyfin libraries on import, rename or delete.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Gotify#

Send media update and health alert push notifications through a Gotify server.

type: Literal['gotify'] = 'gotify' class-attribute instance-attribute #

Type value associated with this kind of connection.

app_token: Password instance-attribute #

App token to use to authenticate with Gotify.

priority: GotifyPriority = GotifyPriority.normal class-attribute instance-attribute #

Gotify notification priority.

Values:

  • min
  • low
  • normal
  • high
include_movie_poster: bool = False class-attribute instance-attribute #

Include movie posters of the relevant media in messages.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Join#

Send media update and health alert push notifications via Join.

type: Literal['join'] = 'join' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use to authenticate with Join.

device_names: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of full or partial device names you'd like to send notifications to.

If unset or empty, all devices will receive notifications.

priority: JoinPriority = JoinPriority.normal class-attribute instance-attribute #

Join push notification priority.

Values:

  • silent
  • quiet
  • normal
  • high
  • emergency
tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Kodi (XBMC)#

Send media update and health alert push notifications to a Kodi (XBMC) media server.

type: Literal['kodi', 'xbmc'] = 'kodi' class-attribute instance-attribute #

Type values associated with this kind of connection.

hostname: NonEmptyStr instance-attribute #

Kodi server hostname.

port: Port = 8080 class-attribute instance-attribute #

Kodi server access port.

use_ssl: bool = False class-attribute instance-attribute #

Connect to the server using HTTPS.

username: NonEmptyStr instance-attribute #

Kodi administrator username.

password: Password instance-attribute #

Kodi user password.

display_notification: bool = False class-attribute instance-attribute #

Display the notification in the Kodi GUI.

display_time: int = 5 class-attribute instance-attribute #

Display time of the notification (in seconds).

clean_library: bool = False class-attribute instance-attribute #

When set to true, clean the library update.

always_update: bool = False class-attribute instance-attribute #

Always update the library, even when a video is playing.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Mailgun#

Send media update and health alert emails via the Mailgun delivery service.

type: Literal['mailgun'] = 'mailgun' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use to authenticate with Mailgun.

use_eu_endpoint: bool = False class-attribute instance-attribute #

Send mail via the EU endpoint instead of the US one.

from_address: NameEmail instance-attribute #

Email address to send the mail as.

RFC-5322 formatted mailbox addresses are also supported, e.g. Radarr <radarr@example.com>.

sender_domain: NonEmptyStr instance-attribute #

The domain from which the mail will be sent.

recipient_addresses: Annotated[List[NameEmail], Field(min_items=1, unique_items=True)] instance-attribute #

The recipient email addresses of the notification mail.

At least one recipient address is required.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Notifiarr#

Send media update and health alert emails via the Notifiarr notification service.

type: Literal['notifiarr'] = 'notifiarr' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use to authenticate with Notifiarr.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

ntfy#

Send media update and health alert emails via the ntfy.sh notification service, or a self-hosted server using the same software.

type: Literal['ntfy'] = 'ntfy' class-attribute instance-attribute #

Type value associated with this kind of connection.

base_url: Optional[AnyHttpUrl] = None class-attribute instance-attribute #

Custom ntfy server URL.

Leave blank, set to null or undefined to use the public server (https://ntfy.sh).

access_token: Optional[SecretStr] = None class-attribute instance-attribute #

Optional token-based authorisation.

When both are defined, access token takes priority over username/password.

username: Optional[str] = None class-attribute instance-attribute #

Username to use to authenticate, if required.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Password to use to authenticate, if required.

priority: NtfyPriority = NtfyPriority.default class-attribute instance-attribute #

Values:

  • min
  • low
  • default
  • high
  • max
topics: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of Topics to send notifications to.

ntfy_tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Optional list of tags or emojis to use.

click_url: Optional[AnyHttpUrl] = None class-attribute instance-attribute #

Optional link for when the user clicks the notification.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Plex Media Server#

Buildarr is unable to manage Plex Media Server notification connections at this time, due to Plex requiring external authentication using OAuth2.

Please add the Plex Media Server notification connection manually in the Radarr UI.

Note

When a Plex Media Server notification connection exists on the Radarr instance, Buildarr will log warnings recognising it as an unsupported type.

These warnings can be ignored, as Buildarr will not modify the notification connection in any way.

Prowl#

Send media update and health alert push notifications to a Prowl client.

type: Literal['prowl'] = 'prowl' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use when authenticating with Prowl.

priority: ProwlPriority = ProwlPriority.normal class-attribute instance-attribute #

Prowl push notification priority.

Values:

  • verylow
  • low
  • normal
  • high
  • emergency
tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Pushbullet#

Send media update and health alert push notifications to Pushbullet devices.

type: Literal['pushbullet'] = 'pushbullet' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use when authenticating with Pushbullet.

device_ids: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of device IDs to send notifications to.

If unset or empty, send to all devices.

channel_tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of Channel Tags to send notifications to.

sender_id: Optional[str] = None class-attribute instance-attribute #

The device ID to send notifications from (device_iden in the device's URL on pushbullet.com).

Leave unset, blank or set to null to send from yourself.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Pushover#

Send media update and health alert push notifications to Pushover devices.

type: Literal['pushover'] = 'pushover' class-attribute instance-attribute #

Type value associated with this kind of connection.

user_key: PushoverApiKey instance-attribute #

User key to use to authenticate with your Pushover account.

api_key: Password instance-attribute #

API key assigned to this application in Pushover.

devices: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of device names to send notifications to.

If unset or empty, send to all devices.

priority: PushoverPriority = PushoverPriority.normal class-attribute instance-attribute #

Pushover push notification priority.

Values:

  • silent
  • quiet
  • normal
  • high
  • emergency
retry: Union[Literal[0], PushoverRetry] = 0 class-attribute instance-attribute #

Interval to retry emergency alerts, in seconds.

Minimum 30 seconds. Set to 0 to disable retrying emergency alerts.

expire: int = Field(0, ge=0, le=86400) class-attribute instance-attribute #

Threshold for retrying emergency alerts, in seconds. If retry is set, this should be set to a higher value.

Maximum 86400 seconds (1 day).

sound: Optional[str] = None class-attribute instance-attribute #

Notification sound to use on devices.

Leave unset, blank or set to null to use the default.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Pushsafer#

Send media update and health alert push notifications to Pushsafer devices.

type: Literal['pushsafer'] = 'pushsafer' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use when authenticating with Pushbullet.

device_ids: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of device IDs to send notifications to.

If unset or empty, send to all devices.

priority: PushsaferPriority = PushsaferPriority.normal class-attribute instance-attribute #

Pushsafer push notification priority.

Values:

  • silent
  • quiet
  • normal
  • high
  • emergency
retry: Union[Literal[0], PushsaferRetry] = 0 class-attribute instance-attribute #

Interval to retry emergency alerts, in seconds.

Minimum 60 seconds. Set to 0 to disable retrying emergency alerts.

expire: int = Field(0, ge=0, le=10800) class-attribute instance-attribute #

Threshold for retrying emergency alerts, in seconds. If retry is set, this should be set to a higher value.

Maximum 10800 seconds (3 hours).

sound: Optional[int] = None class-attribute instance-attribute #

Notification sound number (0-62) to use when alerting.

Leave unset, blank or set to null to use the default.

vibration: Optional[int] = None class-attribute instance-attribute #

Notification pattern (1-3) to use on devices.

Leave unset, blank or set to null to use the device default.

icon: Optional[int] = None class-attribute instance-attribute #

Pushsafer icon number (1-181) to use in notifications.

Leave unset, blank or set to null to use the default Pushsafer icon.

icon_color: Optional[Color] = None class-attribute instance-attribute #

The colour to use for the Pushsafer icon in the notification.

Specify either a colour (e.g. yellow) or a hex code (#00FF00).

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

SendGrid#

Send media update and health alert emails via the SendGrid delivery service.

type: Literal['sendgrid'] = 'sendgrid' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

API key to use to authenticate with SendGrid.

from_address: NameEmail instance-attribute #

Email address to send the mail as.

RFC-5322 formatted mailbox addresses are also supported, e.g. Radarr <radarr@example.com>.

recipient_addresses: Annotated[List[NameEmail], Field(min_items=1, unique_items=True)] instance-attribute #

The recipient email addresses of the notification mail.

At least one recipient address is required.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Signal#

Send media update and health alert messages to a Signal user/group.

type: Literal['signal'] = 'signal' class-attribute instance-attribute #

Type value associated with this kind of connection.

hostname: NonEmptyStr instance-attribute #

Signal API hostname.

port: Port = 8080 class-attribute instance-attribute #

Signal API access port.

use_ssl: bool = False class-attribute instance-attribute #

Use HTTPS instead of HTTP when connecting to Signal API.

sender_number: NonEmptyStr instance-attribute #

Phone number of the sender registered in Signal.

receiver_id: NonEmptyStr instance-attribute #

Group ID / phone number of the receiver.

username: NonEmptyStr instance-attribute #

Signal API auth username.

password: Password instance-attribute #

Signal API auth password.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Simplepush#

Send media update and health alert messages to Simplepush.

type: Literal['simplepush'] = 'simplepush' class-attribute instance-attribute #

Type value associated with this kind of connection.

api_key: Password instance-attribute #

Simplepush API key.

event: Optional[str] = None class-attribute instance-attribute #

Customise the behaviour of push notification.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Slack#

Send media update and health alert messages to a Slack channel.

type: Literal['slack'] = 'slack' class-attribute instance-attribute #

Type value associated with this kind of connection.

webhook_url: AnyHttpUrl instance-attribute #

Webhook URL for the Slack channel to send to.

username: NonEmptyStr instance-attribute #

Username to post as.

icon: Optional[str] = None class-attribute instance-attribute #

The icon that is used for messages from this integration (emoji or URL).

If unset, blank or set to None, use the default for the user.

channel: Optional[str] = None class-attribute instance-attribute #

If set, overrides the default channel in the webhook.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Synology Indexer#

Send media update and health alert push notifications to a Synology Indexer.

type: Literal['synology-indexer', 'synology'] = 'synology-indexer' class-attribute instance-attribute #

Type values associated with this kind of connection.

update_library: bool = False class-attribute instance-attribute #

Call synoindex on localhost to update library files.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

Telegram#

Send media update and health alert messages to a Telegram chat room.

type: Literal['telegram'] = 'telegram' class-attribute instance-attribute #

Type value associated with this kind of connection.

bot_token: Password instance-attribute #

The bot token assigned to this application.

chat_id: NonEmptyStr instance-attribute #

The ID of the chat room to send messages to.

You must start a conversation with the bot or add it to your group to receive messages.

send_silently: bool = False class-attribute instance-attribute #

Sends the message silently. Users will receive a notification with no sound.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.

Trakt#

Buildarr is unable to manage Trakt notification connections at this time, due to Plex requiring external authentication using OAuth2.

Please add the Trakt notification connection manually in the Radarr UI.

Note

When a Trakt notification connection exists on the Radarr instance, Buildarr will log warnings recognising it as an unsupported type.

These warnings can be ignored, as Buildarr will not modify the notification connection in any way.

Twitter#

Buildarr is unable to manage Twitter notification connections at this time, due to Plex requiring external authentication using OAuth2.

Please add the Twitter notification connection manually in the Radarr UI.

Note

When a Twitter notification connection exists on the Radarr instance, Buildarr will log warnings recognising it as an unsupported type.

These warnings can be ignored, as Buildarr will not modify the notification connection in any way.

Webhook#

Send media update and health alert notifications to a webhook API.

type: Literal['webhook'] = 'webhook' class-attribute instance-attribute #

Type value associated with this kind of connection.

method: WebhookMethod = WebhookMethod.POST class-attribute instance-attribute #

HTTP request method type to use.

Values:

  • POST
  • PUT
username: Optional[str] = None class-attribute instance-attribute #

Webhook API username, if required.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Webhook API password, if required.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to associate this notification connection with.

Supported Notification Triggers#
on_grab: bool = False class-attribute instance-attribute #

Notify when movies are available for download and have been sent to a download client.

on_import: bool = False class-attribute instance-attribute #

Notify when movies are successfully imported (downloaded).

on_upgrade: bool = False class-attribute instance-attribute #

Notify when movies are upgraded to a better quality.

on_rename: bool = False class-attribute instance-attribute #

Notify when movies are renamed.

on_movie_added: bool = False class-attribute instance-attribute #

Notify when movies are added to Radarr's library to monitor.

on_movie_delete: bool = False class-attribute instance-attribute #

Notify when movies are deleted.

on_movie_file_delete: bool = False class-attribute instance-attribute #

Notify when movie files are deleted.

on_movie_file_delete_for_upgrade: bool = False class-attribute instance-attribute #

Notify when movie files are deleted for upgrades.

on_health_issue: bool = False class-attribute instance-attribute #

Notify on health check failures.

include_health_warnings: bool = False class-attribute instance-attribute #

When on_health_issue is enabled, notify for health check warnings in addition to errors.

on_health_restored: bool = False class-attribute instance-attribute #

Notify when health check failures have been resolved.

on_manual_interaction_required: bool = False class-attribute instance-attribute #

Notify when manual interaction is required to resolve an issue.

on_application_update: bool = False class-attribute instance-attribute #

Notify when Radarr gets updated to a new version.