<linkrel="search"type="application/opensearchdescription+xml"title="Frigate"href="/frigate/opensearch.xml"><titledata-react-helmet="true">Integration with Home Assistant | Frigate</title><metadata-react-helmet="true"name="twitter:card"content="summary_large_image"><metadata-react-helmet="true"name="docsearch:language"content="en"><metadata-react-helmet="true"name="docsearch:version"content="current"><metadata-react-helmet="true"name="docsearch:docusaurus_tag"content="docs-default-current"><metadata-react-helmet="true"property="og:title"content="Integration with Home Assistant | Frigate"><metadata-react-helmet="true"name="description"content="The best way to integrate with Home Assistant is to use the official integration. When configuring the integration, you will be asked for the Host of your frigate instance. This value should be the url you use to access Frigate in the browser and will look like http5000/. If you are using HassOS with the addon, the host should be http5000 (or http5000 if your are using the beta version of the addon). Home Assistant needs access to port 5000 (api) and 1935 (rtmp) for all features. The integration will setup the following entities within Home Assistant:"><metadata-react-helmet="true"property="og:description"content="The best way to integrate with Home Assistant is to use the official integration. When configuring the integration, you will be asked for the Host of your frigate instance. This value should be the url you use to access Frigate in the browser and will look like http5000/. If you are using HassOS with the addon, the host should be http5000 (or http5000 if your are using the beta version of the addon). Home Assistant needs access to port 5000 (api) and 1935 (rtmp) for all features. The integration will setup the following entities within Home Assistant:"><metadata-react-helmet="true"property="og:url"content="https://blakeblackshear.github.io/frigate/usage/home-assistant"><linkdata-react-helmet="true"rel="shortcut icon"href="/frigate/img/favicon.ico"><linkdata-react-helmet="true"rel="preconnect"href="https://BH4D9OD16A-dsn.algolia.net"crossorigin="anonymous"><linkdata-react-helmet="true"rel="canonical"href="https://blakeblackshear.github.io/frigate/usage/home-assistant"><linkrel="stylesheet"href="/frigate/styles.4dd8d972.css">
Note that some people may not want to expose frigate to the web, so you can leverage the HA API that frigate custom_integration ties into (which is exposed to the web, and thus can be used for mobile notifications etc):</p><p>To load an image taken by frigate from Home Assistants API see below:</p><divclass="mdxCodeBlock_1zKU"><divclass="codeBlockContent_actS"><divtabindex="0"class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><divclass="codeBlockLines_3uvA"style="color:#bfc7d5;background-color:#292d3e"><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain">https://HA_URL/api/frigate/notifications/<event-id>/thumbnail.jpg</span></div></div></div><buttontype="button"aria-label="Copy code to clipboard"class="copyButton_2GIj">Copy</button></div></div><p>To load a video clip taken by frigate from Home Assistants API :</p><divclass="mdxCodeBlock_1zKU"><divclass="codeBlockContent_actS"><divtabindex="0"class="prism-code language-undefined codeBlock_tuNs thin-scrollbar"><divclass="codeBlockLines_3uvA"style="color:#bfc7d5;background-color:#292d3e"><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain">https://HA_URL/api/frigate/notifications/<event-id>/<camera>/clip.mp4</span></div></div></div><buttontype="button"aria-label="Copy code to clipboard"class="copyButton_2GIj">Copy</button></div></div><p>Here is a simple example of a notification automation of events which will update the existing notification for each change. This means the image you see in the notification will update as frigate finds a "better" image.</p><divclass="mdxCodeBlock_1zKU"><divclass="codeBlockContent_actS"><divtabindex="0"class="prism-code language-yaml codeBlock_tuNs thin-scrollbar"><divclass="codeBlockLines_3uvA"style="color:#bfc7d5;background-color:#292d3e"><divclass="token-line"style="color:#bfc7d5"><spanclass="token key atrule">automation</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"></span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">-</span><spanclass="token plain"></span><spanclass="token key atrule">alias</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"> Notify of events</span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token key atrule">trigger</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"></span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token key atrule">platform</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"> mqtt</span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token key atrule">topic</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"> frigate/events</span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token key atrule">action</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"></span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">-</span><spanclass="token plain"></span><spanclass="token key atrule">service</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"> notify.mobile_app_pixel_3</span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token plain"></span><spanclass="token key atrule">data_template</span><spanclass="token punctuation"style="color:rgb(199, 146, 234)">:</span><spanclass="token plain"></span></div><divclass="token-line"style="color:#bfc7d5"><spanclass="token
