Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

integrations: Update HomeAssistant Documentation. 

I have updated the docs for the homeassistant integration to include
numbers to increase visibility.

Fixies part of #17633.
This commit is contained in:
Adam Birds 2021-03-15 21:17:32 +00:00 committed by Tim Abbott
parent eaf0212f6a
commit 8337dce913
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
zerver/webhooks/homeassistant/doc.md
View File

@ -1,29 +1,29 @@
{!create-stream.md!}
1. {!create-stream.md!}
Next, on your {{ settings_html|safe }}, create a bot and
note its email and API key.
1. Next, on your {{ settings_html|safe }}, create a bot and
note its email and API key.
In Home Assistant, you need to add the `notify` service to your
`configuration.yaml` file. This should look something like this:
1. In Home Assistant, you need to add the `notify` service to your
`configuration.yaml` file. This should look something like this:
![](/static/images/integrations/homeassistant/001.png)
![](/static/images/integrations/homeassistant/001.png)
The `api_key` parameter should correspond to your bot's key. The `stream`
parameter is not necessarily required; if not given, it will default to
the `homeassistant` stream.
1. The `api_key` parameter should correspond to your bot's key. The `stream`
parameter is not necessarily required; if not given, it will default to
the `homeassistant` stream.
And the URL under `resource` should start with:
1. And the URL under `resource` should start with:
`{{ api_url }}/v1/external/homeassistant`
`{{ api_url }}/v1/external/homeassistant`
Finally, you need to configure a trigger for the service by adding
an automation entry in the HomeAssistant `configuration.yaml` file.
1. Finally, you need to configure a trigger for the service by adding
an automation entry in the HomeAssistant `configuration.yaml` file.
![](/static/images/integrations/homeassistant/002.png)
![](/static/images/integrations/homeassistant/002.png)
The `data` object takes at least a `message` property and an optional
`title` parameter which will be the conversation topic and which defaults
to `homeassistant` if not given.
The `data` object takes at least a `message` property and an optional
`title` parameter which will be the conversation topic and which defaults
to `homeassistant` if not given.
{!congrats.md!}