2024.11.3
Home ▸ Integrations ▸

Apprise

The Apprise service is an all-in-one solution to open up Home Assistant to just about every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.)

Configuration

To use Apprise supported notifications, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry using URLs
notify:
  - name: NOTIFIER_NAME
    platform: apprise
    url: YOUR_APPRISE_URLS

You can also predefine your own configuration files while storing them either remotely or locally. Simply just use the config option.

# Example configuration.yaml entry using externally located Apprise
# Configuration Files/Sites:
notify:
  - name: NOTIFIER_NAME
    platform: apprise
    config: YOUR_APPRISE_CONFIG_URLS

There is no restriction on the number of URLs or Apprise Configuration locations you wish to define. You can also use both of the lines in conjunction with one another:

# Example configuration.yaml entry using all options
notify:
  - name: NOTIFIER_NAME
    platform: apprise
    config: YOUR_APPRISE_CONFIG_URLS
    url: YOUR_APPRISE_URLS

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

The notifier will bind to the action notify.NAME.

url string (Optional)

One or more Apprise URLs

config string (Optional)

One or more Apprise Configuration URLs

Example action 

- action: notify.NOTIFIER_NAME
  data:
    message: "A message from Home Assistant"

If you’re using configuration files to store your Apprise URLs in, then you have the added bonus of associating tags with them. By default, Apprise in Home Assistant will only notify the elements that have no tags associated with them. You can optionally focus on only notifying a specific service based on the tag(s) you assigned them like so:

- action: notify.NOTIFIER_NAME
  data:
    message: "A message from Home Assistant"
    target: [
      "tag_name1",
    ]

The tag all is reserved to notify absolutely everything, whether you have a tag associated with a URL or not.

Notes

There are over 50 supported Notification services supported by Apprise. Each has their own tweaks and customizations you can leverage.

  • For instructions on how to construct the URLs, visit here.
  • For instructions on how you can customize your own Apprise configuration files (referenced through the config directive), check out the following:

Related topics