Files
zulip/zerver/webhooks/homeassistant/doc.md
Greg Price eb55a3a1ba template context: Give better names to the URLs for the API.
The "subdomain" label is redundant, to the extent it's even
accurate -- this is really just the URL we want to display,
which may or may not involve a subdomain.  Similarly "external".

The former `external_api_path_subdomain` was never a path -- it's a
host, followed by a path, which together form a scheme-relative URL.
I'm not quite convinced that value is actually the right thing in
2 of the 3 places we use it, but fixing that can start by giving an
accurate name to the thing we have.
2017-10-30 18:29:29 -07:00

1004 B

{!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:

{{ 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.

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