Smart-home recipes
A hook is a secret web address. When your smart home calls it, Grovehold does the one thing you chose.
- First have what the hook will act on: a task whose How often is Roughly every… (such as “Vacuum the living room”), or an item on the Status board (the ready-made items include Washing machine and Dishwasher).
- Open Settings › Smart home and tap New hook. Only adults can make hooks.
- Name it, for example “Washing machine finished”, and choose what it does: Freshen a task for the home, Add a task anyone can take or Set a status.
- Tap Create. Grovehold shows the address once: tap Copy address and paste it straight into your smart-home app.
The address looks like https://api.grovehold.com/hooks/in/YOUR-SECRET, though yours may start differently. In the recipes below, put your own address wherever you see that one.
What a hook can do
Freshen a task for the home marks a “roughly every” task done by The house, for example when a robot vacuum finishes. It can’t tick off a task with a date or someone’s turn.
Add a task anyone can take adds a one-off task, such as “Hang up the washing”. While that task is still open, calling the hook again adds nothing.
Set a status moves an item on the status board to one of its states, such as Washing machine to Done, needs hanging. It replaces whatever the status was, even if someone changed it on their phone a moment ago.
Nobody gets points from a hook, and a hook can’t read anything or add to the shopping list. Each hook works up to 10 times in each clock hour. While a home is read-only, its hooks do nothing.
If the task or the status item is archived, or changed so the hook no longer fits, the hook does nothing until it fits again (or you make a new hook). Grovehold acts on every call as it comes, so don’t let your hub repeat a call that failed.
Washing machine (Home Assistant)
A smart plug that measures power can tell when a wash starts and ends. This recipe uses two hooks, both Set a status on the board’s Washing machine: one to Running, one to Done, needs hanging. While a wash runs, the board says so; when it ends, it says it’s done.
These recipes use the automation format of Home Assistant 2024.10 and later. In Home Assistant, add a toggle helper named “Washing machine running” (Settings › Devices & services › Helpers › Create helper › Toggle). Then add the two addresses and the three automations below, and restart Home Assistant. Every recipe’s REST commands go under one rest_command: line: if configuration.yaml already has one, add only the indented lines under it.
grovehold_washing_started: https://api.grovehold.com/hooks/in/YOUR-SECRET
grovehold_washing_done: https://api.grovehold.com/hooks/in/YOUR-SECRETrest_command:
grovehold_washing_started:
url: !secret grovehold_washing_started
method: post
grovehold_washing_done:
url: !secret grovehold_washing_done
method: post- alias: Washing machine started
triggers:
- trigger: numeric_state
entity_id: sensor.washing_machine_plug_power
above: 10
for: "00:02:00"
actions:
- action: input_boolean.turn_on
target:
entity_id: input_boolean.washing_machine_running
- action: rest_command.grovehold_washing_started
- alias: Washing machine finished
triggers:
- trigger: numeric_state
entity_id: sensor.washing_machine_plug_power
below: 5
for: "00:05:00"
conditions:
- condition: state
entity_id: input_boolean.washing_machine_running
state: "on"
actions:
- action: input_boolean.turn_off
target:
entity_id: input_boolean.washing_machine_running
- action: rest_command.grovehold_washing_done
- alias: Washing machine running after a restart
triggers:
- trigger: homeassistant
event: start
conditions:
- condition: numeric_state
entity_id: sensor.washing_machine_plug_power
above: 10
actions:
- action: input_boolean.turn_on
target:
entity_id: input_boolean.washing_machine_running
- action: rest_command.grovehold_washing_startedPut your plug’s power sensor in place of sensor.washing_machine_plug_power. Watch the power during one wash first and change 10 and 5 watts to fit: some machines draw only a few watts while they soak.
Home Assistant only reacts to changes it sees while it’s running, and a restart, or a reload of automations, cancels a wait that has begun. After a restart, the third automation catches a wash that is clearly running (above 10 watts). A start or a finish that comes while Home Assistant is restarting or reloading, or while the plug can’t be read, can be missed: the board may then still say Running, or still show the Done, needs hanging of the wash before.
If the board shows the wrong state, for example Running well after the machine stopped or Done, needs hanging while a wash is going, or a call to Grovehold failed, set the status by hand in Grovehold. The next wash sets the helper right again.
Keeping the addresses in secrets.yaml means you can share the rest of your configuration without them. Home Assistant can still write an address into its log when a call fails, so treat its logs and diagnostics like the address: remove it before you share them, or revoke the hook if you already have.
Robot vacuum back on its dock (Home Assistant)
Make a hook with Freshen a task for the home and pick the “roughly every” task the robot does, such as “Vacuum the living room”. Add its address to secrets.yaml, its REST command (under your existing rest_command: line if you have one), and this automation:
grovehold_vacuumed: https://api.grovehold.com/hooks/in/YOUR-SECRETrest_command:
grovehold_vacuumed:
url: !secret grovehold_vacuumed
method: post- alias: Robot vacuum back on its dock
triggers:
- trigger: state
entity_id: vacuum.robot
from:
- cleaning
- returning
to: docked
actions:
- action: rest_command.grovehold_vacuumedPut your vacuum in place of vacuum.robot, then restart Home Assistant. A run that ends somewhere other than the dock doesn’t count.
Post in the letterbox (a door or contact sensor)
Make a hook with Add a task anyone can take, named for example “Bring in the post”. A contact sensor on the letterbox flap, a shed door or a gate works the same way. As before, the REST command goes under your existing rest_command: line if you have one:
grovehold_post: https://api.grovehold.com/hooks/in/YOUR-SECRETrest_command:
grovehold_post:
url: !secret grovehold_post
method: post- alias: Post in the letterbox
triggers:
- trigger: state
entity_id: binary_sensor.letterbox_flap
to: "on"
actions:
- action: rest_command.grovehold_postPut your sensor in place of binary_sensor.letterbox_flap, then restart Home Assistant. While “Bring in the post” is still open, another call adds nothing, so a flap that bangs twice is fine.
iPhone Shortcuts
A shortcut can call a hook from the Home Screen, the Action button or Siri, for example “Dishwasher on” for a hook that sets Dishwasher to Running.
- Open the Shortcuts app and tap +.
- Add the action Get Contents of URL and paste your hook’s address as its URL.
- Tap Show More, set Method to POST, and leave Request Body empty.
- Name the shortcut, for example “Dishwasher on”, and tap Done.
The shortcut keeps the address inside it. Don’t share the shortcut or upload it to a gallery: whoever gets it gets the address.
IFTTT
IFTTT can call a hook when any of its triggers fires: a smart plug turning off, a button, a time of day.
- Create an applet and choose its trigger under If This.
- Under Then That, choose Webhooks › Make a web request.
- Paste your hook’s address as the URL, set Method to POST, and leave Body empty.
- Save the applet, and keep it private: never publish it.
IFTTT’s Webhooks service may need a paid IFTTT plan.
Any other app
Anything that can send a web request works, such as Homey, Hubitat or Node-RED. Send an HTTP POST to the address, with no body: Grovehold ignores anything sent with it, because the address is the whole message.
The answer is 202 when Grovehold got the call. Its outcome says what happened: applied (it did it), already_open (the task it adds is still open), no_change (the status was already that), or not_applicable (the task or item no longer fits, or the home is read-only). 404 means the address is wrong, was revoked, or its home was closed; 429 means the hook has had its 10 calls this hour.
To see whether it worked, look at the task or the status itself: only that shows a change. Last used under the hook in Smart home (open it again to refresh it) only shows that Grovehold got a call, and doesn’t move while the home is read-only or the hook is over its limit.
If an address gets out, or you lost it
- Open Settings › Smart home.
- Revoke the hook. Its address stops working at once.
- Tap New hook and make the same hook again.
- Paste the new address where the old one was: in secrets.yaml, the shortcut or the applet.
Grovehold shows an address only once and can’t show it again, so a lost address is replaced the same way. While a home is read-only, a new hook can only be made once it has a plan again. The hooks someone made stop working when they leave the home.