Home Assistant

Todoist

This platform allows you to connect to your Todoist projects as todo or calendar entities. All tasks get updated roughly every 15 minutes.

A calendar entity will be on if you have a task due in that project. It will be off if all the tasks in the project are completed or if the project doesn’t have any tasks at all.

Prerequisites

You need to determine your Todoist API token. Go to the Integrations > Developer section on your Todoist settings page and find the section labeled API token at the bottom of the page. Copy that token and use it in your configuration file.

Configuration

To add the Todoist integration to your Home Assistant instance, use this My button:

Custom projects

You can manually configure the Todoist calendar (only) integration using configuration.yaml which can specify “custom” projects which match against criteria you set. You should prefer the above instructions for configuring Todoist from the UI.

To-do list entity

See the todo integration for details on how to manage items on the Todoist to-do list, including services for creating and deleting to-do items.

Todoist completed to-do items are not visible in Home Assistant because they are not returned by the Todoist REST API. Marking a To-do item as completed is effectively deleting it from Home Assistant, though completed tasks are visible in the Todoist UI.

Calendar entity attributes

  • offset_reached: Not used.

  • all_day: True if the reported task doesn’t have a due date. False if there is a due date set.

  • message: The title of the “most important” task coming up in this project.

  • description: A URL pointing to the task on the Todoist website.

  • location: Not used.

  • start_time: The last time the Todoist integration got updated. Usually within the last 15 minutes.

  • end_time: When the task is due.

  • all_tasks: A list of all tasks in this project, sorted from most important to least important.

  • priority: The priority Todoist reports this task as having. 1 means lowest priority, 4 means highest. Note that this is the opposite of how things are displayed in the Todoist app!

  • task_comments: Any comments added to this task.

  • task_labels: All labels associated with this task.

  • overdue: Whether the reported task is past its due date.

  • due_today: Whether the reported task is due today.

Services

You may use the services from the todo integration for creating, updating, or deleting to-do items on the to-do list.

Todoist also comes with an additional service, todoist.new_task that offers more advanced attributes when creating a Todoist task. You can specify labels and a project, or you can leave them blank, and the task will go to your Inbox project.

Here are two example JSON payloads resulting in the same task:

{
    "content": "Pick up the mail",
    "project": "Errands",
    "labels":"Homework,School",
    "priority":3,
    "due_date":"2017-09-12 14:00"
}

{
    "content": "Pick up the mail",
    "project": "Errands",
    "labels":"Homework,School",
    "priority":3,
    "due_date_string":"tomorrow at 14:00",
    "due_date_lang":"en"
}

  • content (Required): The name of the task you want to create.

  • project (Optional): The project to put the task in.

  • labels (Optional): Any labels you want to add to the task, separated by commas.

  • assignee (Optional): A member’s username of a shared project to assign this task to. You find the username formatted as bold text in the collaborator menu of a shared project.

  • priority (Optional): The priority of the task, from 1-4. Again, 1 means least important, and 4 means most important.

  • due_date_string (Optional): When the task should be due, in natural language. Mutually exclusive with due_date

  • due_date_lang (Optional): When due_date_string is set, it is possible to set the language. Valid languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl

  • due_date (Optional): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format (in UTC timezone). Mutually exclusive with due_date_string.

  • reminder_date_string (Optional): When should user be reminded of this task, in natural language. Mutually exclusive with reminder_date

  • reminder_date_lang (Optional): When reminder_date_string is set, it is possible to set the language. Valid languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl

  • reminder_date (Optional): When should the user be reminded of this task, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format (in UTC timezone). Mutually exclusive with reminder_date_string.

Related topics

To-do list