Skip to content

Configuration: Rewards

ccpk1 edited this page Jun 2, 2026 · 4 revisions

Rewards are items that assignees can claim by spending their earned points.

Tip

Per-user assignment: Rewards can be assigned to specific users. By default, all gamified users see every reward. Use the "Assigned to" field when creating or editing a reward to restrict which users can view and claim it.


Creating a Reward

  1. SettingsDevices & ServicesChoreOpsConfigure
  2. Select Manage RewardAdd Reward
  3. Fill in the form and click Submit

Note

During initial setup, you'll be asked "Number of Rewards" - enter count or 0 to skip and add later.


Reward Configuration Fields

Field Type Required Default Description
Reward Name Text - Display name. Must be unique.
Reward Cost Number 10 Points required to claim. Min: 0
Description Text Empty Optional notes.
Reward Labels Label (multi) None Tags for organization (e.g., "treats", "toys").
Icon Icon mdi:gift-outline Icon for entities.
Assigned to User (multi) All gamified users Users who can see and claim this reward.

Tip

Labels help organize: Use labels like "screen_time", "treats", "physical_items" for dashboard filtering.


Reward Claiming Workflow

  1. Assignee claims → Approver notified (no points deducted yet)
  2. Approver approves → Points deducted, reward granted, resets to Available
  3. Approver disapproves → No points involved, resets to Available

Note

Rewards can be claimed multiple times. Each claim is a separate transaction.

Tip

Undo for assignees: Assignees can press the Disapprove button while in Claimed status to undo their claim. This is not tracked as a disapproval statistic.


Entities Created

Each reward creates entities only for its assigned users:

  • Default: All gamified users are assigned and receive entities
  • Custom: Only users selected in the "Assigned to" field receive entities
  • None: If all users are removed, no reward entities are created

Note

Changing assignments via Edit Reward or the update_reward service immediately updates which users see the reward. Removing a user removes their reward entities (sensors and buttons).

  • Status sensor (for example sensor.<user>_choreops_reward_status_<name>)
  • Claim button for assignees
  • Approve/Disapprove buttons for approvers

Reward Sensor Attributes

Reward status sensors include claim state and summary statistics for the current user/reward pair.

For the full attribute contract, use the technical references below.

Note

See Technical: Entities & States and Technical: Points for complete entity and attribute details.


Managing Rewards

Edit a Reward: Configure → Manage Reward → Edit Reward. You can change which users are assigned. Remove users to remove their reward entities.

Delete a Reward: Configure → Manage Reward → Delete Reward.

Warning

Deletion is permanent. All reward entities are removed. Pending claims are auto-disapproved with points refunded.


Notifications

Assignee and approver notifications are sent when rewards are claimed, approved, or disapproved. Configure this in Configuration: Notifications.


Troubleshooting

Issue Solution
User can't claim reward Check user has enough points and is assigned to the reward
"A reward with this name already exists" Choose a unique reward name
Reward entities missing Check user is assigned to the reward; reload integration after changes
Points not refunded on disapproval Check coordinator logs for storage issues

Related Documentation


Last Updated: June 2026 (per-user reward assignment)

Clone this wiki locally