Home Assistant
App · 14 actions
Control your smart home with Home Assistant: turn things on and off, run actions, read sensors and their history, send notifications and talk to Assist. Start a workflow when something changes.
Actions
| Action | What it does |
|---|---|
| Ask Assist | Tell Home Assistant's voice assistant what to do or ask it something, in plain words, such as 'turn off the kitchen lights'. |
| Fire event | Fire an event, for an automation in Home Assistant to react to. |
| Get entity history | Get an entity's states over a span of time, such as a temperature over the last day. |
| Get entity state | Get an entity's state, such as whether a light is on or a sensor's reading, with its attributes. |
| Get server details | Get your Home Assistant's name, version, time zone and temperature unit. |
| List calendar events | List the events on one of Home Assistant's calendars between two times. |
| List entities | List entities and their states, of one kind (such as light or sensor) or with names containing words. |
| Render template | Work out a Home Assistant template, such as {{ states('sensor.outside_temperature') }}. |
| Run action | Run any Home Assistant action, such as setting a thermostat or locking a door, with its data. |
| Send notification | Send a notification to a phone with the Home Assistant app, or another target set up in Home Assistant. |
| Set entity state | Set what Home Assistant shows for an entity, such as a sensor's value. |
| Toggle | Turn things on if they're off, and off if they're on. |
| Turn off | Turn off lights, switches, fans and more. |
| Turn on | Turn on lights, switches, fans, scenes, scripts and more. |
Ask Assist
Tell Home Assistant's voice assistant what to do or ask it something, in plain words, such as 'turn off the kitchen lights'.
Inputs
- Say
texttextRequired - What to say, as you would to Assist.
- Language
languagetext - The language it's in, such as en or de. Defaults to the server's.
Outputs
conversation_idtext- The conversation, to continue it
replytext- What Assist answered
response_typetext- action_done, query_answer or error
Example output
{
"conversation_id": "01JB9X",
"reply": "Turned off the kitchen lights",
"response_type": "action_done"
}Fire event
Fire an event, for an automation in Home Assistant to react to. Needs an administrator's token.
Inputs
- Event
event_typetextRequired - The event's name, such as lodol_order_shipped, as your automation listens for it.
- Data
dataobject - Fields and values to send with it.
Outputs
event_typetext- The event fired
firedtrue/false- True once fired
Example output
{
"event_type": "lodol_order_shipped",
"fired": true
}Get entity history
Get an entity's states over a span of time, such as a temperature over the last day.
Inputs
- Entity
entitytextRequired - The entity to read.
- From
startdate and time - The start of the span. Defaults to a day ago.
- Until
enddate and time - The end of the span. Defaults to now.
Outputs
changeslist- Its states, oldest first
countnumber- How many states
entity_idtext- The entity
Example output
{
"changes": [
{
"changed_at": "2026-10-28T08:00:00+00:00",
"state": "11.2"
}
],
"count": 1,
"entity_id": "sensor.outside_temperature"
}Get entity state
Get an entity's state, such as whether a light is on or a sensor's reading, with its attributes.
Inputs
- Entity
entitytextRequired - The entity to read.
Outputs
attributesobject- Its attributes, such as brightness or battery level
entity_idtext- The entity's ID, such as light.kitchen
last_changedtext- When its state last changed (ISO 8601)
last_updatedtext- When it was last updated (ISO 8601)
nametext- Its name
statetext- Its state, such as on, off, 21.5 or home
unittext- The state's unit, such as °C, if it has one
Example output
{
"attributes": {
"brightness": 204,
"friendly_name": "Kitchen light"
},
"entity_id": "light.kitchen",
"last_changed": "2026-10-28T08:59:00+00:00",
"last_updated": "2026-10-28T08:59:00+00:00",
"name": "Kitchen light",
"state": "on",
"unit": ""
}Get server details
Get your Home Assistant's name, version, time zone and temperature unit.
Inputs
None.
Outputs
location_nametext- The home's name
statetext- RUNNING once it has started
temperature_unittext- Its temperature unit
time_zonetext- Its time zone
versiontext- Home Assistant's version
Example output
{
"location_name": "Home",
"state": "RUNNING",
"temperature_unit": "\u00b0C",
"time_zone": "Europe/London",
"version": "2026.10.1"
}List calendar events
List the events on one of Home Assistant's calendars between two times.
Inputs
- Calendar
calendartextRequired - The calendar, such as calendar.family.
- From
startdate and time - The start of the span. Defaults to now.
- Until
enddate and time - The end of the span. Defaults to a week after 'From'.
Outputs
calendartext- The calendar
countnumber- How many events
eventslist- The events
Example output
{
"calendar": "calendar.family",
"count": 1,
"events": [
{
"all_day": true,
"description": "",
"end": "2026-10-30",
"location": "",
"start": "2026-10-29",
"title": "Bins out"
}
]
}List entities
List entities and their states, of one kind (such as light or sensor) or with names containing words.
Inputs
- Kind
domaintext - Only entities of this kind, such as light, switch or sensor.
- Name contains
searchtext - Only entities whose name or ID contains these words.
- How many
limitnumber - The most entities to return. Defaults to 100.From 1 to 2000.
Outputs
countnumber- How many
entitieslist- The entities
Example output
{
"count": 1,
"entities": [
{
"attributes": {
"brightness": 204,
"friendly_name": "Kitchen light"
},
"entity_id": "light.kitchen",
"last_changed": "2026-10-28T08:59:00+00:00",
"last_updated": "2026-10-28T08:59:00+00:00",
"name": "Kitchen light",
"state": "on",
"unit": ""
}
]
}Render template
Work out a Home Assistant template, such as {{ states('sensor.outside_temperature') }}. Needs an administrator's token.
Inputs
- Template
templatetextRequired - The template, in Home Assistant's Jinja syntax.
Outputs
resulttext- What the template works out to
Example output
{
"result": "11.2"
}Run action
Run any Home Assistant action, such as setting a thermostat or locking a door, with its data.
Inputs
- Action
action_idtextRequired - The action to run, such as climate.set_temperature.
- Entities
entitylist - The entities to run it on, if it takes any.
- Data
dataobject - The action's fields and values, such as temperature: 21.
- Return its answer
return_responsetrue/false - Return the data the action answers with, for actions that give one, such as weather.get_forecasts.Default:
false.
Outputs
actiontext- The action that ran
changedlist- The entities whose state changed
responseobject- What the action answered, when asked to return it
Example output
{
"action": "climate.set_temperature",
"changed": [],
"response": {}
}Send notification
Send a notification to a phone with the Home Assistant app, or another target set up in Home Assistant.
Inputs
- Send to
notifiertextRequired - Where to send it, such as a phone's mobile_app target.
- Message
messagetextRequired - What the notification says.
- Title
titletext - A title above the message.
Outputs
notifiertext- Where it was sent
senttrue/false- True once sent
Example output
{
"notifier": "mobile_app_pixel_8",
"sent": true
}Set entity state
Set what Home Assistant shows for an entity, such as a sensor's value. It doesn't control a device. Needs an administrator's token.
Inputs
- Entity
entitytextRequired - The entity, such as sensor.open_orders. One that doesn't exist yet is made.
- State
statetextRequired - The value to show.
- Attributes
attributesobject - Attributes to show with it, such as unit_of_measurement: orders.
Outputs
attributesobject- Its attributes, such as brightness or battery level
createdtrue/false- True if the entity was new
entity_idtext- The entity's ID, such as light.kitchen
last_changedtext- When its state last changed (ISO 8601)
last_updatedtext- When it was last updated (ISO 8601)
nametext- Its name
statetext- Its state, such as on, off, 21.5 or home
unittext- The state's unit, such as °C, if it has one
Example output
{
"attributes": {
"brightness": 204,
"friendly_name": "Kitchen light"
},
"created": false,
"entity_id": "sensor.open_orders",
"last_changed": "2026-10-28T08:59:00+00:00",
"last_updated": "2026-10-28T08:59:00+00:00",
"name": "Kitchen light",
"state": "12",
"unit": ""
}Toggle
Turn things on if they're off, and off if they're on.
Inputs
- Entities
entitylistRequired - What to toggle.
Outputs
changedlist- The entities whose state changed
entitieslist- The entities asked for
Example output
{
"changed": [
{
"attributes": {
"brightness": 204,
"friendly_name": "Kitchen light"
},
"entity_id": "light.kitchen",
"last_changed": "2026-10-28T08:59:00+00:00",
"last_updated": "2026-10-28T08:59:00+00:00",
"name": "Kitchen light",
"state": "on",
"unit": ""
}
],
"entities": [
"light.kitchen"
]
}Turn off
Turn off lights, switches, fans and more.
Inputs
- Entities
entitylistRequired - What to turn off.
Outputs
changedlist- The entities whose state changed
entitieslist- The entities asked for
Example output
{
"changed": [
{
"attributes": {},
"entity_id": "light.kitchen",
"last_changed": "2026-10-28T08:59:00+00:00",
"last_updated": "2026-10-28T08:59:00+00:00",
"name": "Kitchen light",
"state": "off",
"unit": ""
}
],
"entities": [
"light.kitchen"
]
}Turn on
Turn on lights, switches, fans, scenes, scripts and more.
Inputs
- Entities
entitylistRequired - What to turn on.
- Brightness
brightness_percentnumber - For lights, how bright, from 0 to 100 percent.From 0 to 100.
Outputs
changedlist- The entities whose state changed
entitieslist- The entities asked for
Example output
{
"changed": [
{
"attributes": {
"brightness": 204,
"friendly_name": "Kitchen light"
},
"entity_id": "light.kitchen",
"last_changed": "2026-10-28T08:59:00+00:00",
"last_updated": "2026-10-28T08:59:00+00:00",
"name": "Kitchen light",
"state": "on",
"unit": ""
}
],
"entities": [
"light.kitchen"
]
}