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 triggers

For the moments Home Assistant cannot name. ⏰

Spook provides new triggers to Home Assistant. This reference page lists them all and points you to the right documentation for that trigger.

All of these happened

Fires when every one of several triggers has fired inside the same window of time, in any order. Home Assistant’s own triggers are a list where any one of them is enough; this is the other one. #and #together #combination

spook.all_of, documentation 📚

Automation turned off

Fires when an automation is turned off, by somebody or by something, so the one switched off while chasing a problem does not stay off unnoticed. #automation #disabled #off

spook.automation_turned_off, documentation 📚

Cron schedule

Fires on a crontab schedule, for the times Home Assistant’s own time triggers cannot express, like every weekday at seven or the last Friday of the month. #crontab

spook.cron, documentation 📚

Device added

Fires when a new device is added to Home Assistant, like a plug that was just paired, whoever paired it. #device #new #paired

spook.device_added, documentation 📚

Device discovered

Fires when Home Assistant discovers something new it could set up, like a device that just turned up on your network. #discovery #device #new #network

spook.device_discovered, documentation 📚

Entity came back

Fires when an entity returns after having been unavailable for a while, so a router rebooting does not read as everything in the house recovering. #recovered #back #unavailable

spook.recovered, documentation 📚

Entity fell silent

Fires when nothing has written to an entity for a while, which catches the device that died quietly instead of going unavailable. #stale #silent #dead

spook.stale, documentation 📚

Integration added

Fires when an integration is added to Home Assistant, by you, by somebody else, or by Home Assistant itself. #integration #config-entry #new

spook.integration_added, documentation 📚

Integration failed to set up

Fires when a configuration entry has been unable to set itself up for a while, past the point where Home Assistant’s own retries would have sorted it out. #integration #broken #config-entry

spook.integration_failed, documentation 📚

Once it settles

Fires once a trigger has stopped firing for a while, so a burst of them arrives as one. A motion sensor does not report motion once, it reports it twenty times. #debounce #burst #quiet

spook.debounce, documentation 📚

Position reached

Fires when a cover or valve gets to a position, or moves past it: the blinds at a third, the valve half open. #cover #valve #position

spook.position_reached, documentation 📚

Repair issue created

Fires when a new repair issue turns up, so you hear about one without visiting the repairs page. Can be narrowed by integration and severity. #repairs #issue

spook.repair_issue_created, documentation 📚

Repair issue resolved

Fires when a repair issue goes away, either fixed or no longer reported. #repairs #issue

spook.repair_issue_removed, documentation 📚

Script started

Fires when a script starts a run, picked in the editor rather than typed into an event trigger, and only for a run the script lets through. #script #run #started

spook.script_started, documentation 📚

Spook’s state trigger

Fires when an entity changes state, for everything a label, area, floor or device covers, or every entity of a domain, integration or device class, with things excluded again. Ignores unavailable and attribute noise, survives a blip while waiting out a duration, and can wait before it fires. #state #label #area #wildcard

spook.state_changed, documentation 📚

Target temperature reached

Fires when the temperature of a thermostat or water heater reaches its target: the bathroom is warm, the water is hot. #climate #thermostat #temperature

spook.target_temperature_reached, documentation 📚

Update installed

Fires when an update entity reports a different installed version, whether somebody pressed install, the device updated itself, or it was updated outside of Home Assistant. #update #firmware #installed

spook.update_installed, documentation 📚

User added

Fires when somebody is given a login to Home Assistant, which an admin would rather hear about than stumble upon. #user #account #security

spook.user_added, documentation 📚

Condition turned true

Fires when a condition goes from false to true, using the same condition building blocks as anywhere else. #condition #template

spook.condition_met, documentation 📚

Triggers in order

Fires when several triggers happen one after another, in the order given, optionally within a time limit. #sequence #order #timeout

spook.sequence, documentation 📚

While a condition holds

Fires when a condition turns true and keeps firing on an interval for as long as it stays true, without holding a script run open. #condition #repeat #reminder

spook.while, documentation 📚

Watchdog

Fires when something that was expected to happen does not happen in time, without needing a helper entity and a timer to arrange it. #absence #timeout #watchdog

spook.watchdog, documentation 📚

Entity will not settle

Fires when an entity changes state more often than it should within a stretch of time, which is how a failing device usually announces itself. #flapping #device-health #unavailable

spook.flapping, documentation 📚