paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

webhooks/homeassistant: Migrate docs to Markdown.

Browse Source
This commit is contained in:
Eeshan Garg
2017-06-12 21:58:29 -02:30
committed by Tim Abbott
parent cfa0f5332a
commit 571130e2fe
5 changed files with 30 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
zerver/webhooks/homeassistant/doc.html
View File

@@ -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
View 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:
![](/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.
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.
![](/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.
{!congrats.md!}
![](/static/images/integrations/homeassistant/003.png)