Skip to main content

Set State

Sets a state in Home Assistant.

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​

PropertyFieldDescription
AttributesinAttributesAdditional attributes as JSON (optional)
Client IDinClientIDClient ID from Connect node
Entity IDinEntityIDEntity ID to set state for (e.g. sensor.my_sensor,input_boolean.my_flag)
StateinStateNew state value (e.g. on,off,23.5)

Outputs​

PropertyFieldDescription
ResultoutResultUpdated entity state object

Options​

PropertyFieldDescription
Base URLoptBaseURLHome Assistant URL (required when using credentials directly)
CredentialsoptCredentialsHome Assistant Access Token (use instead of Connect node)

Requirements​

  • A Client ID from this package's Connect node, unless you set credentials directly on this node.
  • 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.

Connect · Disconnect · Get State · Get All States · Call Service · Get Services · Fire Event · Get Config · Render Template · Get Error Log and 1 more

See also​