Home Assistant WebSocket API

The websocket_api integration set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the http integration.


# Example configuration.yaml entry

For details to use the WebSocket API, please refer to the WebSocket API documentation .

Track current connections

The WebSocket API provides a sensor that will keep track of the number of currently connected clients. You can add it by adding the following to your configuration:

# Example configuration.yaml entry
  - platform: websocket_api

This will create a sensor called sensor.connected_clients whose value is the total number of connected clients.