snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/homeassistant/doc.md

@@ -0,0 +1,45 @@
+1. {!create-channel.md!}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. In Home Assistant, you need to add the `notify` service to your
+    `configuration.yaml` file.  This should look something like this:
+
+    ```
+    notify:
+      - platform: rest
+        resource: http: {{ external_api_uri }}v1/external/homeassistant?api_key=<API key>
+        method: POST_JSON
+        title_param_name: topic
+    ```
+
+1. 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` channel.
+
+1. And the URL under `resource` should start with:
+
+    `{{ api_url }}/v1/external/homeassistant`
+
+1. Finally, you need to configure a trigger for the service by adding
+    an automation entry in the HomeAssistant `configuration.yaml` file.
+
+    ```
+    automation:
+      trigger:
+        platform: sun
+        event: sunrise
+      action:
+        - service: notify.notify
+          data:
+            message: "It will be 30 degrees Celsius out there today!"
+            title: "Weather forecast"
+    ```
+
+    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/001.png)