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-14 21:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update matrix notify component configuration (#7545)

Browse Source
This commit is contained in:
Klaas Schoute 2018-11-17 11:28:13 +01:00 committed by Fabian Affolter
parent 6b6623bf4a
commit 1607f608eb
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_components/notify.matrix.markdown
View File

@ -12,7 +12,6 @@ ha_category: Notifications
ha_release: 0.32
---
The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](http://matrix.org) room. Rooms can be both direct as well as group chats.
## {% linkable_title Configuration %}
@ -28,10 +27,17 @@ notify:
default_room: ROOM_ID_OR_ALIAS
```
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **default_room** (*Required*): The room all messages will be sent to, when no other target is given.
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
default_room:
description: The room all messages will be sent to, when no other target is given.
required: true
type: string
{% endconfiguration %}
The target room has to be precreated, the room id can be obtained from the rooms settings dialog. Rooms by default have a canonical id of the form `"!<randomid>:homeserver.tld"`, but can also be allocated aliases like `"#roomname:homeserver.tld"`. Make sure to use quotes around the room id or alias to escape special characters (`!`, and `#`) in YAML. The notifying account may need to be invited to the room, depending on the individual rooms policies.