mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 22:43:42 +00:00
webhooks/homeassistant: Migrate docs to Markdown.
This commit is contained in:
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
@@ -1,45 +0,0 @@
|
|||||||
<p>
|
|
||||||
In Zulip, create a <code>homeassistant</code> stream which will
|
|
||||||
contain the received notifications. You also need a bot which you
|
|
||||||
can create in the {{ settings_html|safe }}.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
In Home Assistant, you need to add the <code>notify</code> service
|
|
||||||
to your <code>configuration.yaml</code> file. This should look
|
|
||||||
something like this:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<img src="/static/images/integrations/homeassistant/notify-settings-config-yaml.png"/>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
The <code>api-key</code> parameter should correspond to your bot's
|
|
||||||
key. The <code>stream</code> parameter is not necessarily
|
|
||||||
required; if not given, it will default to
|
|
||||||
the <code>homeassistant</code> stream. And the URL under
|
|
||||||
`resource` should start with
|
|
||||||
<code>{{ external_api_uri_subdomain }}/v1/external/homeassistant</code>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Finally, you need to configure a trigger for the service by adding
|
|
||||||
an automation entry in the
|
|
||||||
HomeAssistant <code>configuration.yaml</code> file.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<img src="/static/images/integrations/homeassistant/automation-settings-config-yaml.png"/>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
The <code>data</code> object takes at least a <code>message</code>
|
|
||||||
property and an optional <code>title</code> parameter which will
|
|
||||||
be the conversation topic and which defaults
|
|
||||||
to <code>homeassistant</code> if not given.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
You'll now get notifications like this:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<img src="/static/images/integrations/homeassistant/result-message.png"/>
|
|
||||||
|
|
||||||
<p>You just got the Home Assistant integration working. Congratulations!</p>
|
|
||||||
30
zerver/webhooks/homeassistant/doc.md
Normal file
30
zerver/webhooks/homeassistant/doc.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
{!create-stream.md!}
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
`{{ external_api_uri_subdomain }}/v1/external/homeassistant`
|
||||||
|
|
||||||
|
Finally, you need to configure a trigger for the service by adding
|
||||||
|
an automation entry in the HomeAssistant `configuration.yaml` file.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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!}
|
||||||
|
|
||||||
|

|
||||||
Reference in New Issue
Block a user