jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Apprise example to include name (#28580)

Browse Source 
* Update Apprise example to include name

* clarify that name is user-defined

---------

Co-authored-by: Matthew Foran <matthew.j.foran.civ@army.mil>
This commit is contained in:
Matthew Foran 2023-09-11 02:29:18 -04:00 committed by GitHub
parent e6ef726bba
commit d68555da59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
source/_integrations/apprise.markdown
View File

@ -22,7 +22,8 @@ To use Apprise supported notifications, add the following to your `configuration
```yaml
# Example configuration.yaml entry using URLs
notify:
- platform: apprise
- name: NOTIFIER_NAME
platform: apprise
url: YOUR_APPRISE_URLS
```
@ -32,7 +33,8 @@ You can also pre-define your own configuration files while storing them either r
# Example configuration.yaml entry using externally located Apprise
# Configuration Files/Sites:
notify:
- platform: apprise
- name: NOTIFIER_NAME
platform: apprise
config: YOUR_APPRISE_CONFIG_URLS
```
@ -41,7 +43,8 @@ There is no restriction on the number of URLs or Apprise Configuration locations
```yaml
# Example configuration.yaml entry using all options
notify:
- platform: apprise
- name: NOTIFIER_NAME
platform: apprise
config: YOUR_APPRISE_CONFIG_URLS
url: YOUR_APPRISE_URLS
```
@ -65,7 +68,7 @@ config:
## Example service call
```yaml
- service: notify.apprise
- service: notify.NOTIFIER_NAME
data:
message: "A message from Home Assistant"
```
@ -73,7 +76,7 @@ config:
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:
```yaml
- service: notify.apprise
- service: notify.NOTIFIER_NAME
data:
message: "A message from Home Assistant"
target: [