zulip/zerver/webhooks/homeassistant/doc.md at 5a9452f3e68b608b51a0a5dc1d3e35999ba65fa7

mirror of https://github.com/zulip/zulip.git synced 2025-11-09 16:37:23 +00:00

Files

David Rosa 620854d437 integrations: Add incoming webhook macro to relevant docs.

Several integration docs instruct the user to create a bot, but don't
specify that the type of bot should be "Incoming webhook".

Renames create-a-bot.md -> create-an-incoming-webhook.md for clarity,
and replaces all incomplete instructions with this macro.
Renames bot_types.png -> bot_types_incoming_webhook.png and updates
the image with a screenshot of the latest UI.

2022-09-09 16:31:33 -07:00

1017 B

Raw Blame History

{!create-stream.md!}
{!create-an-incoming-webhook.md!}
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!}

1017 B Raw Blame History

1017 B

Raw Blame History