To-do list

The To-do list integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides to-do list entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], allowing other integrations to integrate to-do lists into Home Assistant. To-do lists are shown on the To-do lists dashboard for tracking items and whether they have been completed.

For example, Local to-do is a fully local integration to create to-do lists and tasks within your Home Assistant instance, Shopping list specifically for shopping that can be added to with Assist, or other integrations work with online services providing to-do list data.

Viewing and managing to-do lists

Each to-do list is represented as its own entity in Home Assistant and can be viewed and managed on a to-do list dashboard. You can find the to-do list dashboard in the main sidebar of your Home Assistant instance.

The state of a to-do list entity

The state of a to-do list entity is a number, which represents the number of incomplete items in the list.

Screenshot showing the state of a to-do list entity in the developer tools.

In addition, the entity can have the following states:

• Unavailable: The entity is currently unavailable.
• Unknown: The state is not yet known.

Blueprint to add an item to a dedicated list

This blueprint allows you to create a script to add an item to a pre-configured to-do list.

List of triggers

The To-do list integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following triggers. Each link below opens a dedicated page with examples, fields, and a step-by-step UI walkthrough.

• To-do item added (todo.item_added) Triggers when a to-do item is added to a list.

• To-do item completed (todo.item_completed) Triggers when a to-do item is marked as done.

• To-do item removed (todo.item_removed) Triggers when a to-do item is removed from a list.

For an overview of every trigger across all integrations, see the triggers reference.

List of conditions

The To-do list integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following conditions. Each link below opens a dedicated page with examples, fields, and a step-by-step UI walkthrough.

• All to-do items completed (todo.all_completed) Tests if all to-do items are completed in one or more to-do lists.

• Incomplete to-do items (todo.incomplete) Tests the number of incomplete to-do items in one or more to-do lists.

For an overview of every condition across all integrations, see the conditions reference.

List of actions

The To-do list integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.

• Add to-do list item (todo.add_item) Adds a new item to a to-do list.

• Get to-do list items (todo.get_items) Gets the items on a to-do list.

• Remove completed to-do list items (todo.remove_completed_items) Removes all completed items from a to-do list.

• Remove to-do list item (todo.remove_item) Removes an item from a to-do list.

• Update to-do list item (todo.update_item) Updates an existing item on a to-do list.

For an overview of every action across all integrations, see the actions reference.

To-do list automation examples

To-do list triggers and conditions make it easier to react to changes in a list or check whether a list still needs attention.

Automation: send a notification when someone adds a shopping item

If you share a shopping list with your household, this automation lets you know right away when someone adds a new item.

• Trigger: To-do item added
• Target: Shopping list
• Action: Send a notification message
  • Target: My Device (notify.my_device)

alias: "Notify me when a shopping item is added"
triggers:
  - trigger: todo.item_added
    target:
      entity_id: todo.shopping_list
actions:
  - action: notify.send_message
    target:
      entity_id: notify.my_device
    data:
      message: >
        A new item was added to the shopping list.

Automation: lock the front door when the evening checklist is finished

If you keep an evening checklist in Home Assistant, this automation locks the front door after the last task is marked complete.

• Trigger: To-do item completed
• Condition: All to-do items completed
• Target: Evening checklist
• Action: Lock lock

alias: "Lock the front door when the evening checklist is done"
triggers:
  - trigger: todo.item_completed
    target:
      entity_id: todo.evening_checklist
conditions:
  - condition: todo.all_completed
    target:
      entity_id: todo.evening_checklist
actions:
  - action: lock.lock
    target:
      entity_id: lock.front_door