Skip to content

Services

Jump to bottom
tempus2016 edited this page Mar 25, 2026 · 3 revisions

TaskMate exposes services that can be called from automations, scripts, the Developer Tools, or the HA mobile app.

All services are under the taskmate domain.

complete_chore

Mark a chore as completed by a child.

Parameter Required Description
chore_id Yes ID of the chore to complete
child_id Yes ID of the child completing the chore

If the chore has requires_approval: true, a pending completion is created. Points are held until approved.

service: taskmate.complete_chore
data:
  chore_id: b3f9a12c
  child_id: a8c8376a

approve_chore

Approve a pending chore completion and award points.

Parameter Required Description
completion_id Yes ID of the completion to approve

Points are awarded on approval. Weekend multiplier and streak milestone bonuses are applied at this point.

service: taskmate.approve_chore
data:
  completion_id: 9f1e3b7a

Finding the completion_id: Check sensor.taskmate_overview attributes → pending_completions array, or sensor.pending_approvals attributes → chore_completions array.

reject_chore

Reject a pending chore completion. No points are awarded.

Parameter Required Description
completion_id Yes ID of the completion to reject

The completion record is removed entirely.

service: taskmate.reject_chore
data:
  completion_id: 9f1e3b7a

claim_reward

Create a pending reward claim for a child. Points are not deducted until the claim is approved.

Parameter Required Description
reward_id Yes ID of the reward to claim
child_id Yes ID of the child claiming the reward 
service: taskmate.claim_reward
data:
  reward_id: e7c2a91f
  child_id: a8c8376a

approve_reward

Approve a reward claim. Points are deducted from the child's balance.

Parameter Required Description
claim_id Yes ID of the reward claim to approve 
service: taskmate.approve_reward
data:
  claim_id: 4d8b2f1e

Finding the claim_id: Check sensor.pending_approvals attributes → reward_claims array, or sensor.taskmate_overview attributes → pending_reward_claims.

reject_reward

Reject a reward claim. No points are deducted (they were never deducted).

Parameter Required Description
claim_id Yes ID of the reward claim to reject 
service: taskmate.reject_reward
data:
  claim_id: 4d8b2f1e

add_points

Manually add bonus points to a child. Logged in the activity feed.

Parameter Required Description
child_id Yes ID of the child
points Yes Number of points to add (1–10000)
reason No Optional reason shown in activity feed 
service: taskmate.add_points
data:
  child_id: a8c8376a
  points: 10
  reason: "Helped with the shopping"

remove_points

Manually remove points from a child (consequence/penalty). Logged in the activity feed.

Parameter Required Description
child_id Yes ID of the child
points Yes Number of points to remove (1–10000)
reason No Optional reason shown in activity feed 
service: taskmate.remove_points
data:
  child_id: a8c8376a
  points: 5
  reason: "Left shoes on the stairs"

set_chore_order

Set the custom display order for chores on a child's card.

Parameter Required Description
child_id Yes ID of the child
chore_order Yes Ordered list of chore IDs 
service: taskmate.set_chore_order
data:
  child_id: a8c8376a
  chore_order:
    - b3f9a12c
    - e7c2a91f
    - 4d8b2f1e

preview_sound

Fire a browser event to preview a completion sound. Useful for testing sounds during chore setup.

Parameter Required Description
sound Yes Sound name to preview 
service: taskmate.preview_sound
data:
  sound: fanfare

Valid values: none, coin, levelup, fanfare, chime, powerup, undo, fart1–fart10, fart_random

The sound plays in the browser where the HA frontend is open. It does not play through speakers or media players.

Using Services in Developer Tools

  1. Go to Developer Tools → Services
  2. Search for taskmate
  3. Select the service
  4. Fill in the parameters using the visual form or YAML mode
  5. Click Call Service

Button Entities

TaskMate also creates HA Button entities for common actions that don't need parameters:

  • button.{child_name}_complete_{chore_name} — one button per child/chore combination
  • button.{child_name}_claim_{reward_name} — one button per child/reward combination

These appear in Settings → Devices & Services → TaskMate → Entities and can be used in dashboards or automations without needing to know the IDs.

Penalty Services

taskmate.add_penalty

Create a new penalty definition.

Parameter Required Description
name Yes Display name
points Yes Points to deduct when applied
description No Optional explanation
icon No MDI icon slug

taskmate.update_penalty

Update an existing penalty.

Parameter Required Description
penalty_id Yes ID of the penalty
name No New name
points No New point value
description No New description
icon No New MDI icon

taskmate.remove_penalty

Delete a penalty definition.

Parameter Required Description
penalty_id Yes ID of the penalty

taskmate.apply_penalty

Apply a penalty to a child — points deducted immediately.

Parameter Required Description
penalty_id Yes ID of the penalty
child_id Yes ID of the child

Clone this wiki locally