Home Assistant

Manage Home Assistant smart home devices, states, services, events, camera screenshots, and more.

Overview

The Home Assistant tool connects to a Home Assistant instance via its REST API. It supports 8 resources: Camera Proxy (get a screenshot as binary), Config (get/check), Event (create/get many), History (get state changes), Log (error logs and logbook entries), Service (call/get many), State (get/get many/upsert), and Template (render Jinja2). The Camera Proxy operation produces binary image data. Authentication uses a Long-Lived Access Token.

Category: Utility
Tool Name: home_assistant
Version: 1

Appearance: Icon: si-homeassistant | Color: #41BDF5

Node Type

Action (Binary) — handles file/binary data operations

Input / Output

Direction	Port(s)
Input	Input
Output	Output, Error

Credentials

This tool requires Home Assistant API credentials. See the Credentials Guide for setup instructions.

Resources

Resource	Value
Camera Proxy	cameraProxy
Config	config
Event	event
History	history
Log	log
Service	service
State	state
Template	template

Operations

Operation	Value	Description
Get Screenshot	getScreenshot	Camera Proxy — get the camera screenshot
Get	get	Config — get the configuration
Check Configuration	check	Config — check the configuration for errors
Get Many	getAll	Event — get many events
Create	create	Event — fire a custom event
Get Many	getAll	History — get many state changes
Get Error Logs	getErroLogs	Log — get the error log
Get Logbook Entries	getLogbookEntries	Log — get logbook entries
Get Many	getAll	Service — get many services
Call	call	Service — call a service within a specific domain
Get	get	State — get the state of a specific entity
Get Many	getAll	State — get many states
Create or Update	upsert	State — create a new state or update an existing one
Render	create	Template — render a Jinja2 template

Operation values are scoped to their resource, so the same value can mean different things: get reads the configuration under Config and one entity’s state under State, and create fires an event under Event but renders a template under Template.

Parameters

Config → Get, Config → Check Configuration and Log → Get Error Logs take no parameters of their own — see All Operations.

Camera Proxy: Get Screenshot

Parameter	Type	Required	Default	Description
Camera Entity ID	string	Yes	—	Camera entity ID (e.g., “camera.front_door”). Get from GET /api/states filtered to entities starting with “camera.”. Supports expressions like {{ $json.camera }}.
Binary Property	string	Yes	data	Name of the output binary field to store the screenshot image in. Names are case-sensitive.

Event: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)

Event: Create

Parameter	Type	Required	Default	Description
Event Type	string	Yes	—	The event type name to fire (e.g., “my_custom_event”). Supports expressions.
Event Attributes	fixedCollection	No	{}	Key-value pairs to include as the event data payload. Add one entry per attribute.
— Name	string	No	—	Attribute name.
— Value	string	No	—	Attribute value.

History: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)
Additional Fields	collection	No	{}	Optional filters narrowing the history query.
— Start Time	dateTime	No	—	The beginning of the period (appended to URL path).
— End Time	dateTime	No	—	The end of the period.
— Entity IDs	string	No	—	Comma-separated entity IDs to filter.
— Minimal Response	boolean	No	false	Whether to only return last_changed and state for states.
— Significant Changes Only	boolean	No	false	Whether to only return significant state changes.

Log: Get Logbook Entries

Parameter	Type	Required	Default	Description
Additional Fields	collection	No	{}	Optional filters narrowing the logbook query.
— Start Time	dateTime	No	—	The beginning of the period.
— End Time	dateTime	No	—	The end of the period.
— Entity ID	string	No	—	Entity ID to filter logbook entries.

Service: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)

Service: Call

Parameter	Type	Required	Default	Description
Domain	string	Yes	—	Service domain (e.g., “light”, “switch”, “automation”). Get domains from GET /api/services. Supports expressions.
Service	string	Yes	—	Service name (e.g., “turn_on”, “turn_off”, “toggle”). Get services from GET /api/services filtered by domain. Supports expressions.
Service Attributes	fixedCollection	No	{}	Key-value pairs to pass to the service (e.g., entity_id, brightness). Add one entry per attribute.
— Name	string	No	—	Name of the field.
— Value	string	No	—	Value of the field.

State: Get

Parameter	Type	Required	Default	Description
Entity ID	string	Yes	—	Entity ID (e.g., “sensor.temperature”, “light.kitchen”). Get from GET /api/states. Supports expressions.

State: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)

State: Create or Update

Parameter	Type	Required	Default	Description
Entity ID	string	Yes	—	The entity ID for which a state will be created or updated. Get from GET /api/states. Supports expressions.
State	string	Yes	—	The state value to set (e.g., “on”, “off”, “21.5”). Supports expressions.
State Attributes	fixedCollection	No	{}	Key-value attribute pairs for the state. Add one entry per attribute.
— Name	string	No	—	Attribute name.
— Value	string	No	—	Attribute value.

Template: Render

Parameter	Type	Required	Default	Description
Template	string	Yes	—	Jinja2 template string to render (e.g., {{ states("sensor.temperature") }}). Supports expressions.

All Operations

Parameter	Type	Required	Default	Description
Max Concurrency	number	No	10	Maximum number of items to process concurrently.

Output Data

Results are merged into the item JSON at the top level, so the incoming fields stay addressable alongside them, and binary data from upstream is forwarded. Several operations return a list — those fan out to one output item per result rather than nesting an array on a single item, so no Split Out node is needed.

Resource: Operation	Items out	What lands on the item
Camera Proxy: Get Screenshot	1	The item JSON is unchanged. The screenshot is written to the binary property you named, as screenshot.jpg with the content type Home Assistant returned, and merged alongside any binary the item already carried.
Config: Get	1	The full Home Assistant configuration — version, location, unit system, time zone, components and paths.
Config: Check Configuration	1	The configuration check result — whether the configuration is valid and any errors found.
Event: Get Many	one per event	Each event listener object Home Assistant knows about, capped by Limit unless Return All is on.
Event: Create	1	Home Assistant’s acknowledgement of the fired event. A plain-text acknowledgement is placed on message.
History: Get Many	one per entity group	Home Assistant returns history grouped by entity, and each group is placed on history as an array of state records. When nothing matches, a single item is emitted with history: [].
Log: Get Error Logs	1	errorLog — the raw error log as one string.
Log: Get Logbook Entries	one per entry	Each logbook entry merged onto its own item. When nothing matches, the input item passes through unchanged.
Service: Get Many	one per domain	Each service domain with the services it exposes, capped by Limit unless Return All is on.
Service: Call	one per affected entity	Home Assistant returns the states it changed, and each becomes its own item. A service that changes nothing returns an empty list, and the input item passes through unchanged.
State: Get	1	The entity’s state object — its entity_id, current state, attributes and change timestamps.
State: Get Many	one per entity	The same state object for every entity, capped by Limit unless Return All is on.
State: Create or Update	1	The state object as Home Assistant stored it after the write.
Template: Render	1	renderedTemplate — the rendered template output as a string.

Reference the result downstream by expression, for example {{ $json.state }} after a State: Get, or {{ $json.renderedTemplate }} after a Template: Render.

Usage Examples

• Get the current state of a temperature sensor
• Turn on a light using service call
• Capture a camera screenshot
• Fire a custom event
• Get the Home Assistant configuration
• Render a Jinja2 template
• Get error logs from Home Assistant

Example Configuration

Read one entity’s current state:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "state",
    "operation": "get",
    "entityId": "sensor.living_room_temperature"
  }
}

Turn a light on at half brightness:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "service",
    "operation": "call",
    "domain": "light",
    "service": "turn_on",
    "serviceAttributes": {
      "attributes": [
        { "name": "entity_id", "value": "light.kitchen" },
        { "name": "brightness", "value": "128" }
      ]
    }
  }
}

Capture a camera screenshot into the item’s binary data:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "cameraProxy",
    "operation": "getScreenshot",
    "cameraEntityId": "{{ $json.camera }}",
    "binaryPropertyName": "data"
  }
}

Fire a custom event carrying a payload:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "event",
    "operation": "create",
    "eventType": "workflow_alert",
    "eventAttributes": {
      "attributes": [
        { "name": "source", "value": "busybot" },
        { "name": "severity", "value": "{{ $json.severity }}" }
      ]
    }
  }
}

List every entity’s state, not just the first fifty:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "state",
    "operation": "getAll",
    "returnAll": true
  }
}

Pull a day of history for two sensors, keeping the response small:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "history",
    "operation": "getAll",
    "returnAll": true,
    "additionalFields": {
      "startTime": "2026-03-14T00:00:00Z",
      "endTime": "2026-03-15T00:00:00Z",
      "entityIds": "sensor.living_room_temperature,sensor.hallway_humidity",
      "minimalResponse": true
    }
  }
}

Render a Jinja2 template against live state:

{
  "type": "home_assistant",
  "parameters": {
    "resource": "template",
    "operation": "create",
    "template": "It is {{ states('sensor.living_room_temperature') }} degrees."
  }
}

Error Handling

Mode	Behavior
stop	Halts workflow on first error
continue	Skips failed items, passes successful ones through
errorPort	Routes failed items to Error output port

Tips

Control Home Assistant smart home devices, read states, call services, fire events, and capture camera screenshots via the HA REST API.

• Entity IDs follow domain.entity_name — light.kitchen, sensor.temperature, camera.front_door. Read the exact IDs from a State: Get Many run.
• Attribute collections take one entry per key. Event Attributes, Service Attributes and State Attributes are all name/value lists; add a row for each key you want to send rather than pasting a JSON object.
• Additional Fields is a flat collection. Its fields nest under additionalFields and are not wrapped in an array.
• Return All bypasses Limit. With Return All off, results are cut to Limit (default 50, maximum 100) after the request, so a large instance still transfers everything before trimming.
• Camera screenshots come out as binary, not JSON. The image lands on the binary property you name and existing binary on the item is preserved, so a screenshot can sit next to an earlier attachment.
• Create or Update writes a state, it does not control a device. Setting a state through the API records a value; use Service: Call to actually switch something on or off.
• Templates render server-side. The Jinja2 string is evaluated by Home Assistant with access to live state, and the result comes back as text on renderedTemplate.
• Home Assistant is self-hosted, so the instance URL on the credential must be reachable from the workflow platform, and no external rate limit applies.