Document the matrix notification platform #1215
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
Landrash
requested changes
Oct 12, 2016
| @@ -0,0 +1,40 @@ | |||
| -- | |||
| --- | ||
|
|
||
|
|
||
| The `matrix` platform allows you to deliver notifications from Home Assistant to a matrix room. Rooms can be both direct as well as group chats. |
There was a problem hiding this comment.
Matrix without capital letter.
| ```yaml | ||
| # Example configuration.yaml entry | ||
| notify: | ||
| - name: NOTIFIER_NAME |
There was a problem hiding this comment.
Remove the notifier name variable. In general we try to minimize the examples since they are often cut and pasted.
| - **room** (*Required*): The room the messages will be sent to. | ||
| - **verify_ssl** (*Optional*): Verify the homeservers certificate. Defaults to `true`. | ||
|
|
||
| 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`. The notifying account may need to be invited to the room, depending on its policies. |
There was a problem hiding this comment.
Might be a good plan to specify that it's the rooms policies that require the invitation.
|
Ok, applied the requested changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for the
Matrixplatform submitted inhome-assistant/home-assistant#3827.home-assistant/core#3827