Connect
Opens a connection to Home Assistant and returns a Client ID.
This node is also exposed as an AI Agent tool.
This node has 1 input port and 1 output port.
Common Properties
Every node shares these.
- Name — the node's display name on the canvas.
- Color — the node's colour on the canvas.
- Delay Before (sec) — wait this long before the node runs.
- Delay After (sec) — wait this long after the node runs.
- Continue On Error — carry on instead of failing the flow. Defaults to false.
info
When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.
Inputs
| Property | Field | Description |
|---|---|---|
| Base URL | inBaseURL | Home Assistant base URL (e.g. http://localhost:8123) |
Outputs
| Property | Field | Description |
|---|---|---|
| Client ID | outClientID | Unique identifier for this connection |
Options
| Property | Field | Description |
|---|---|---|
| Credentials | optCredentials | Home Assistant Long-Lived Access Token |
Requirements
- Home Assistant Access Token — Long-lived access token for Home Assistant API authentication
value— Access Token (password, required). Long-lived access token from Home Assistant
Store these in a Vault and reference the vault item from the node, rather than typing the secret into the property.
Related nodes
Disconnect · Get State · Get All States · Set State · Call Service · Get Services · Fire Event · Get Config · Render Template · Get Error Log and 1 more
See also
- Home Assistant — every node in this package
- Message object — how properties read values from
msg - Handling failure — Continue On Error, Catch and retries