mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Add Todoist todo component documentation (#29495)
* Add documentation for the Todoist todo platform * Wording improvements to todoist documentation * tiny tweaks * tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
3522bc337a
commit
f4f056bf71
@ -3,6 +3,7 @@ title: Todoist
|
||||
description: Instructions on how to integrate Todoist into Home Assistant.
|
||||
ha_category:
|
||||
- Calendar
|
||||
- To-do List
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.54
|
||||
ha_codeowners:
|
||||
@ -14,7 +15,10 @@ ha_integration_type: integration
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
This platform allows you to connect to your [Todoist Projects](https://todoist.com) as [calendar](/integrations/calendar/) entities. A calendar entity will be `on` if you have a task due in that project or `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all. All tasks get updated roughly every 15 minutes.
|
||||
This platform allows you to connect to your [Todoist projects](https://todoist.com) as [todo](/integrations/todo/) or [calendar](/integrations/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
|
||||
|
||||
@ -22,9 +26,12 @@ You need to determine your Todoist API token. Go to the [**Integrations** > **De
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Custom Projects
|
||||
## Custom projects
|
||||
|
||||
You can manually configure the integration using `configuration.yaml` which can specify "custom" projects which match against criteria you set.
|
||||
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.
|
||||
|
||||
{% details "Manual custom projects configuration" %}
|
||||
|
||||
{% configuration %}
|
||||
token:
|
||||
@ -89,7 +96,20 @@ You can mix-and-match these attributes to create all sorts of custom projects. Y
|
||||
|
||||
Home Assistant does its best to [determine what task in each project is "most" important](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/todoist/calendar.py), and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below).
|
||||
|
||||
## Calendar Entity attributes
|
||||
{% enddetails %}
|
||||
|
||||
## To-do list entity
|
||||
|
||||
See the [todo](/integrations/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.
|
||||
|
||||
@ -119,7 +139,13 @@ Home Assistant does its best to [determine what task in each project is "most" i
|
||||
|
||||
## Services
|
||||
|
||||
Todoist also comes with access to a service, `todoist.new_task`. This service can be used to create a new Todoist task. You can specify labels and a project, or you can leave them blank, and the task will go to your "Inbox" project.
|
||||
You may use the services from the [todo](/integrations/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:
|
||||
|
||||
@ -166,6 +192,4 @@ Here are two example JSON payloads resulting in the same task:
|
||||
- **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 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`.
|
||||
|
||||
Note that there's (currently) no way to mark tasks as done through Home Assistant; task names do not necessarily have to be unique, so you could find yourself in a situation where you close the wrong task.
|
||||
- **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`.
|
Loading…
x
Reference in New Issue
Block a user