zulip/zerver/webhooks/homeassistant/doc.md at 4.x

mirror of https://github.com/zulip/zulip.git synced 2025-11-01 20:44:04 +00:00

Files

Adam Birds 8337dce913 integrations: Update HomeAssistant Documentation.

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

Fixies part of #17633.

2021-03-16 15:29:47 -07:00

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