Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Reference

Provided Home Assistant actions

Ready? Set? Action! 🎬

Spook provides quite a lot of new actions to Home Assistant. This reference page lists them all and points you to the right documentation for that action.

Areas: Create an area

Instantly create new rooms in your home. #BobTheBuilder

homeassistant.create_area, Try this action, documentation 📚

Areas: Update an area

Changes an area without deleting it first, so everything in it stays put. #makeover

homeassistant.update_area, Try this action, documentation 📚

Areas: Delete an area

Just like that, you made an area of your home disappear. #DemolitionMan

homeassistant.delete_area, Try this action, documentation 📚

Areas: Add an alias to an area

Adds an alias (or multiple aliases) to an area. #aka

homeassistant.add_alias_to_area, Try this action, documentation

Areas: Remove an alias from an area

Removes an alias (or multiple aliases) from an area. #broom

homeassistant.remove_alias_from_area, Try this action, documentation

Areas: Set aliases for an area

Sets the aliases for an area. #useless

homeassistant.set_area_aliases, Try this action, documentation

Areas: Add a device to an area

Dynamically add/move a device to a new area. #moveit

homeassistant.add_device_to_area, Try this action, documentation

Areas: Remove a device from an area

Dynamically remove a device from an area. #poef

homeassistant.remove_device_from_area, Try this action, documentation

Areas: Add an entity to an area

Dynamically add/move an entity to an area. #bam

homeassistant.add_entity_to_area, Try this action, documentation

Areas: Remove an entity from an area

Dynamically remove an entity from an area. #AaaaandItIsGone

homeassistant.remove_entity_from_area, Try this action, documentation

Automation: Snooze

Turns an automation off for a while, and turns it back on when the time is up. It survives a restart, so a snooze does not quietly become a disable. #automation #quiet #temporary

automation.snooze, Try this action, documentation 📚

Automation: Turn on for

Turns an automation on for a while, and turns it back off when the time is up. It survives a restart, so “just for tonight” does not quietly become forever. #automation #temporary

automation.turn_on_for, Try this action, documentation 📚

Blueprint: Import Blueprint

Downloads and imports an automation/script blueprint, directly from the URL you pass into this action. #noquestionsasked

blueprint.import, Try this action, documentation 📚

Calendar: Delete event

Deletes events from a calendar, found by their title or uid in a stretch of time, and hands back what it deleted. #calendar #tidyup

calendar.delete_event, Try this action, documentation 📚

Calendar: Update event

Changes events in a calendar, found by their title or uid in a stretch of time: rename, move, or give them a place. Hands back what it changed. #calendar #reschedule

calendar.update_event, Try this action, documentation 📚

Climate: Increase temperature

Turns a thermostat’s setpoint up a step, within its limits, both setpoints for one that heats and cools. #climate #warmer

climate.increase_temperature, Try this action, documentation 📚

Climate: Decrease temperature

Turns a thermostat’s setpoint down a step, within its limits, both setpoints for one that heats and cools. #climate #colder

climate.decrease_temperature, Try this action, documentation 📚

Cover: Increase position

Moves a cover a step further open, stopping at fully open. #cover #blinds #open

cover.increase_position, Try this action, documentation 📚

Cover: Decrease position

Moves a cover a step further closed, stopping at fully closed. #cover #blinds #close

cover.decrease_position, Try this action, documentation 📚

Group: Add members

Adds entities to a group while the house is running, which the interface only lets you do by hand. #roomforonemore

group.add_members, Try this action, documentation 📚

Group: Remove members

Takes entities out of a group while the house is running. Naming something that is not in it does nothing, so it also clears out a member that no longer exists. #youdonthavetogohome

group.remove_members, Try this action, documentation 📚

Group: Set members

Replaces a group’s members with the ones you give it. #allchange

group.set_members, Try this action, documentation 📚

Light: Set brightness

Sets the brightness of lights that are already on, and leaves the ones that are off alone. #light #adjust

light.set_brightness, Try this action, documentation 📚

Light: Increase brightness

Turns up the lights that are already on, stepping each from its own level instead of the group average. #light #adjust

light.increase_brightness, Try this action, documentation 📚

Light: Decrease brightness

Turns down the lights that are already on, stopping at the dimmest they go rather than switching them off. #light #adjust

light.decrease_brightness, Try this action, documentation 📚

Light: Set color

Sets the color of lights that are already on, and passes over the ones that cannot do color. #light #adjust

light.set_color, Try this action, documentation 📚

Light: Set color temperature

Sets the color temperature of lights that are already on, each within the range it can actually reach. #light #adjust

light.set_color_temperature, Try this action, documentation 📚

Light: Set effect

Sets an effect on the lights that are already on and actually have it. #light #adjust

light.set_effect, Try this action, documentation 📚

Media player: Increase volume

Turns a media player’s volume up by exactly the step you give, stopping at full volume. #media_player #louder

media_player.increase_volume, Try this action, documentation 📚

Media player: Decrease volume

Turns a media player’s volume down by exactly the step you give, stopping at silent. #media_player #quieter

media_player.decrease_volume, Try this action, documentation 📚

Valve: Increase position

Moves a valve a step further open, stopping at fully open. #valve #open

valve.increase_position, Try this action, documentation 📚

Valve: Decrease position

Moves a valve a step further closed, stopping at fully closed. #valve #close

valve.decrease_position, Try this action, documentation 📚

Water heater: Increase temperature

Turns a water heater’s setpoint up a step, within its limits. #water_heater #warmer

water_heater.increase_temperature, Try this action, documentation 📚

Water heater: Decrease temperature

Turns a water heater’s setpoint down a step, within its limits. #water_heater #colder

water_heater.decrease_temperature, Try this action, documentation 📚

Wait for a condition

Waits until a condition is true, and carries on straight away if it already is. Takes the ordinary condition building blocks, so it needs no template. #wait #condition

spook.wait_for_condition, Try this action, documentation 📚

Boo!

This action call will just always spook the hell out of Home Assistant. Home Assistant will shit its pants and abort the automation or script. #spooked

spook.boo, Try this action, documentation 📚

Delete all orphaned entities

Deletes all orphaned entities that no longer have an integration that claim/provide them. Please note, if the integration was just removed, it might need a restart for Home Assistant to realize they are orphaned. #annie

homeassistant.delete_all_orphaned_entities, Try this action, documentation 📚

Device: Disable

This action can be used to disable a device on the fly. #whatever

homeassistant.disable_device, Try this action, documentation 📚

Device: Enable

Guess what... this action does the reverse of Device: Disable. #noway

homeassistant.enable_device, Try this action, documentation 📚

Device: Update

Rename a device, move it to another area or change its labels, all in one go. #glowup

homeassistant.update_device, Try this action, documentation 📚

Entity: Disable

This action can be used to disable a entity on the fly. #rocketship

homeassistant.disable_entity, Try this action, documentation 📚

Entity: Enable

Really... this action does the reverse of Entity: Disable. #true

homeassistant.enable_entity, Try this action, documentation 📚

Entity: Hide

This action can be used to hide a entity on the fly. #secret

homeassistant.hide_entity, Try this action, documentation 📚

Entity: Unhide

Do the math... this action does the reverse of Entity: Hide. #reveal

homeassistant.unhide_entity, Try this action, documentation 📚

Entity: Rename

This action can be used to rename an entity on the fly. #LookMaNewName

homeassistant.rename_entity, Try this action, documentation 📚

Entity: Set icon

Give an entity another icon, or its own back. #newlook

homeassistant.set_entity_icon, Try this action, documentation 📚

Entity: Add an alias

Another name a voice assistant knows an entity by. #akaalias

homeassistant.add_alias_to_entity, Try this action, documentation 📚

Entity: Remove an alias

One name fewer for an entity to answer to. #nevercallmethat

homeassistant.remove_alias_from_entity, Try this action, documentation 📚

Entity: Set aliases

All the names an entity answers to, in one go. #akaalias

homeassistant.set_entity_aliases, Try this action, documentation 📚

Entity: Expose to assistants

Lets your voice assistants see an entity that was hidden from them. #saymyname

homeassistant.expose_entity, Try this action, documentation 📚

Entity: Stop exposing to assistants

Takes an entity back out of a voice assistant’s reach. This action does the reverse of Entity: Expose to assistants. #neverheardofher

homeassistant.unexpose_entity, Try this action, documentation 📚

Entity: Update ID

This action can be used to update the ID of an entity on the fly. #secret

homeassistant.update_entity_id, Try this action, documentation 📚

Floors: Create a floor

Instantly create a new floor in your home. #StackItUp

homeassistant.create_floor, Try this action, documentation 📚

Floors: Update a floor

Changes a floor without deleting it first, so every area stays on it. #renovation

homeassistant.update_floor, Try this action, documentation 📚

Floors: Delete a floor

Just like that, a whole floor is gone. #Illusionist

homeassistant.delete_floor, Try this action, documentation 📚

Floors: Add an alias to a floor

Adds an alias (or multiple aliases) to a floor. #aka

homeassistant.add_alias_to_floor, Try this action, documentation 📚

Floors: Remove an alias from a floor

Removes an alias (or multiple aliases) from a floor. #broom

homeassistant.remove_alias_from_floor, Try this action, documentation 📚

Floors: Set aliases for a floor

Sets the aliases for a floor. #useless

homeassistant.set_floor_aliases, Try this action, documentation 📚

Floors: Add an area to a floor

Dynamically add/move an area to a new floor. #moveit

homeassistant.add_area_to_floor, Try this action, documentation 📚

Floors: Remove an area from a floor

Dynamically remove an area from a floor. #poef

homeassistant.remove_area_from_floor, Try this action, documentation 📚

List all orphaned database entities

Hands back every entity your recorder still has rows for but which no longer exists, so you can look before you delete. #showmethebodies

homeassistant.list_orphaned_database_entities, Try this action, documentation 📚

Ignore all discovered devices & services

Click ignore on all discovered items on the integration dashboard; optionally only for specific integration (like, bluetooth). #talktothehand

homeassistant.ignore_all_discovered, Try this action, documentation 📚

Counter: Create

Creates a counter helper without a trip to the helpers page. #outofthinair

counter.create, Try this action, documentation 📚

Counter: Delete

Deletes counter helpers made in the UI, or with counter.create. #countmeout

counter.delete, Try this action, documentation 📚

Humidifier: Increase humidity

Turns a humidifier’s target humidity up a step, within its limits. #humidifier #wetter

humidifier.increase_humidity, Try this action, documentation 📚

Humidifier: Decrease humidity

Turns a humidifier’s target humidity down a step, within its limits. #humidifier #drier

humidifier.decrease_humidity, Try this action, documentation 📚

Input boolean: Create

Creates an input boolean helper without a trip to the helpers page. #outofthinair

input_boolean.create, Try this action, documentation 📚

Input boolean: Delete

Deletes input boolean helpers made in the UI, or with input_boolean.create. #flipoff

input_boolean.delete, Try this action, documentation 📚

Input button: Create

Creates an input button helper without a trip to the helpers page. #outofthinair

input_button.create, Try this action, documentation 📚

Input button: Delete

Deletes input button helpers made in the UI, or with input_button.create. #unpressed

input_button.delete, Try this action, documentation 📚

Input datetime: Create

Creates an input datetime helper without a trip to the helpers page. #outofthinair

input_datetime.create, Try this action, documentation 📚

Input datetime: Delete

Deletes input datetime helpers made in the UI, or with input_datetime.create. #outoftime

input_datetime.delete, Try this action, documentation 📚

Input number: Create

Creates an input number helper without going anywhere near the helpers page. #outofthinair

input_number.create, Try this action, documentation 📚

Input number: Delete

Removes an input number helper you created earlier. #nevermind

input_number.delete, Try this action, documentation 📚

Input number: Decrease value

Override of the existing action, which provides the option to specify the amount to decrease the value by. #evenlower

input_number.decrement, Try this action, documentation 📚

Input number: Increase value

Override of the existing action, which provides the option to specify the amount to increase the value by. #moreoptions

input_number.increment, Try this action, documentation 📚

Input number: Set maximum value

Set the value of an input number entity to the maximum value. #maxout

input_number.max, Try this action, documentation 📚

Input number: Set minimum value

Set the value of an input number entity to the maximum value.

input_number.min, Try this action, documentation 📚

Input number: Set range

Changes the minimum, maximum or step of an input number made in the UI, the same as editing it, so a slider can follow what it measures. #min #max #slider

input_number.set_range, Try this action, documentation 📚

Input select: Create

Creates an input select helper without a trip to the helpers page. #outofthinair

input_select.create, Try this action, documentation 📚

Input select: Delete

Deletes input select helpers made in the UI, or with input_select.create. #nochoice

input_select.delete, Try this action, documentation 📚

Input select: Select random option

This action selects a random option from the list of options of a select entity. Optionally this can be limited to a set of given options. #shuffle

input_select.random, Try this action, documentation 📚

Input select: Reverse options

Reverses the order of the selectable options for an input select entity, back to front, so a list that grows at the end has its newest at the top. #reverse #order

input_select.reverse, Try this action, documentation 📚

Input select: Shuffle options

Shuffles the list of selectable options for an input select entity. #31254

input_select.shuffle, Try this action, documentation 📚

Input select: Sort options

Sorts the list of selectable options for an input select entity. #12345

input_select.sort, Try this action, documentation 📚

Input text: Create

Creates an input text helper without a trip to the helpers page. #outofthinair

input_text.create, Try this action, documentation 📚

Input text: Delete

Deletes input text helpers made in the UI, or with input_text.create. #nomorewords

input_text.delete, Try this action, documentation 📚

Integration: Disable

This action can be used to disable an integration entry (those you see on your integrations dashboard) on the fly. #bye

homeassistant.disable_config_entry, Try this action, documentation 📚

Integration: Enable

Be amazed... this action does the reverse of Input text: Create. #mindblown

homeassistant.enable_config_entry, Try this action, documentation 📚

Integration: Disable polling for updates

This action can be used to disable polling for updates on an integration entry (those you see on your integrations dashboard). #stopit

homeassistant.disable_polling, Try this action, documentation 📚

Integration: Enable polling for updates

This action can be used to enable polling for updates on an integration entry (those you see on your integrations dashboard). This service does the reverse of Integration: Disable polling for updates #poking

homeassistant.enable_polling, Try this action, documentation 📚

Categories: Create a category

Make a new category for automations, scripts, scenes, or helpers. #FileIt

homeassistant.create_category, Try this action, documentation 📚

Categories: Update a category

Rename a category, or give it another icon, without emptying it first. #Relabel

homeassistant.update_category, Try this action, documentation 📚

Categories: Delete a category

The category goes, and whatever was in it is left loose. #Unfiled

homeassistant.delete_category, Try this action, documentation 📚

Categories: Add a category to an entity

Puts automations, scripts, scenes, or helpers in a category. #FileIt

homeassistant.add_category_to_entity, Try this action, documentation 📚

Categories: Remove a category from an entity

Takes automations, scripts, scenes, or helpers out of a category. #Unfile

homeassistant.remove_category_from_entity, Try this action, documentation 📚

Labels: Create a label

Instantly create a new label in your home. #LabelMaker

homeassistant.create_label, Try this action, documentation 📚

Labels: Update a label

Changes a label without deleting it first, so it stays on everything it was on. #facelift

homeassistant.update_label, Try this action, documentation 📚

Labels: Delete a label

Just like that, a whole label is gone. #RipItOff

homeassistant.delete_label, Try this action, documentation 📚

Labels: Add a label to an area

Adds a label (or multiple labels) to an area. #TagIt

homeassistant.add_label_to_area, Try this action, documentation 📚

Labels: Remove a label from an area

Removes a label (or multiple labels) from an area. #UntagIt

homeassistant.remove_label_from_area, Try this action, documentation 📚

Labels: Add a label to a device

Adds a label (or multiple labels) to a device. #TagIt

homeassistant.add_label_to_device, Try this action, documentation 📚

Labels: Remove a label from a device

Removes a label (or multiple labels) from a device. #UntagIt

homeassistant.remove_label_from_device, Try this action, documentation 📚

Labels: Add a label to an entity

Adds a label (or multiple labels) to an entity. #TagIt

homeassistant.add_label_to_entity, Try this action, documentation 📚

Labels: Remove a label from an entity

Removes a label (or multiple labels) from an entity. #UntagIt

homeassistant.remove_label_from_entity, Try this action, documentation 📚

Number: Decrease value

Decrease the value of a number entity, either by a single step or by a provided amount. #downboy

number.decrement, Try this action, documentation 📚

Number: Increase value

Increase the value of a number entity, either by a single step or by a provided amount. #up #greatmovie

number.increment, Try this action, documentation 📚

Number: Set maximum value

Set the value of a number entity to the maximum value. #maxout

number.max, Try this action, documentation 📚

Number: Set minimum value

Set the value of a number entity to its minimum value. #lowout

number.min, Try this action, documentation 📚

Person: Add a device tracker

Adds a device tracker to a person. #bigbrother

person.add_device_tracker, Try this action, documentation 📚

Person: Remove a device tracker

Removes a device tracker from a person. #privacy

person.remove_device_tracker, Try this action, documentation 📚

Random fail

This action call will randomly fail (and thus randomly stop your automation or script). Especially combined with continue_on_error: true this can be a great way to add useless action to your automation or script. #random

spook.random_fail, Try this action, documentation 📚

Recorder: Import statistics

Advanced action to directly inject historical statistics data into the recorder’s long-term stats database. #easy

recorder.import_statistics, Try this action, documentation 📚

Repairs: Create issue

Battery empty? Raise an issue in Home Assistant Repairs. Although, you should probably just use a notification for this. #issues

repairs.create, Try this action, documentation 📚

Repairs: Ignore all issues

Whatever issue is bothering you, just ignore it all, and all your problems will magically be gone. #allgood

repairs.ignore_all, Try this action, documentation 📚

Repairs: List issues

What is still broken, as a list, for an automation or a dashboard of your own. #todolist

repairs.list, Try this action, documentation 📚

Repairs: Remove issue

Removes an issue from Home Assistant Repairs. Can only remove repair issues that have been created using the repairs.create action. #trashit

repairs.remove, Try this action, documentation 📚

Repairs: Unignore all issues

Will unignore all issues marked ignored and shows them all again. #faceit

repairs.unignore_all, Try this action, documentation 📚

Restart

Extends the existing restart action with a “force” option. Because forcing is always a good idea. #hammer

homeassistant.restart, Try this action, documentation 📚

Schedule: Create

Creates a schedule helper, with its whole week of time blocks, without a trip to the helpers page. #outofthinair

schedule.create, Try this action, documentation 📚

Schedule: Delete

Deletes schedule helpers made in the UI, without a trip to the helpers page. #clearedcalendar

schedule.delete, Try this action, documentation 📚

Schedule: Set the time blocks of a day

Replaces the time blocks of one or more days of a schedule, without opening its dialog. #weekplanner

schedule.set_day, Try this action, documentation 📚

Select: Select random option

This action selects a random option from the list of options of a select entity. Optionally this can be limited to a set of given options. #random

select.random, Try this action, documentation 📚

Sensor: Set display precision

Sets how many decimals a sensor shows, on as many sensors as you like at once. #decimated

sensor.set_display_precision, Try this action, documentation 📚

Timer: Create

Creates a timer helper without a trip to the helpers page. #outofthinair

timer.create, Try this action, documentation 📚

Timer: Delete

Deletes timer helpers made in the UI, or with timer.create. #timesup

timer.delete, Try this action, documentation 📚

Timer: Set duration

Set the duration for a timer entity. #timeflies

timer.set_duration, Try this action, documentation 📚

To-do list: Move item

Moves an item in a to-do list to the top, the bottom, or after another item, the way dragging it in the interface does. #todo #reorder

todo.move_item, Try this action, documentation 📚

++(user-disable)=

User: Disable

This action can be used to disable a user account on the fly, preventing them from logging in. #lockout

homeassistant.disable_user, Try this action, documentation 📚

User: Enable

Guess what... this action does the reverse of User: Disable. #welcome

homeassistant.enable_user, Try this action, documentation 📚

Zone: Create

Creates a zone on the fly, wherever you like. #roomforonemore

zone.create, Try this action, documentation 📚

Zone: Update

Moves a zone, or resizes it, without touching the map yourself. This action changes a zone made by Zone: Create, or any other zone you created in the UI. #movingday

zone.update, Try this action, documentation 📚

Zone: Delete

Makes a zone disappear. #offthemap

zone.delete, Try this action, documentation 📚