As a user of both Home Assistant and the to-do/task management app TickTick I was always envious of those using the popular alternative, Todoist. While the way TickTick works and displays tasks and projects suits my way of working much better, it has one big disadvantage when compared to the ever-popular Todoist: There is no open and documented API. And without a proper way of integrating the service, there unfortunately won’t be an official integration baked into Home Assistant anytime soon.
Luckily though, developer Jens L. was apparently facing the same issues as I did, and they created a usable and stable custom component allowing Home Assistant to integrate with TickTick. Please note that this integration is a reverse-engineering of the TickTick web app. There is a strong possibility that this integration might stop working at any given moment without any warning.
An open and documented API would be a great addition to TickTick, and is one I’ve been waiting for since I began using Home Assistant. If you too are wanting to integrate TickTick with Home Assistant in a more official and fully fledged manner, make your voice heard on the TickTick forums.
Table of Contents
- What you need to integrate TickTick with Home Assistant
- Adding the TickTick integration to Home Assistant
- Integrating Home Assistant with TickTick
- Finding the TickTick project ID
What you need to integrate TickTick with Home Assistant
This TickTick integration is by no means as mature as the official Todoist integration with Home Assistant. Thus, it won’t be suitable for those looking to customize tasks to the nth degree. You will be able to add tasks, assign them to a certain project, and set a due date, but nothing more.
As a reverse-engineering, you will need to have set up a password for TickTick. You won’t be able to sign in using Google, Apple, Facebook, or Twitter. But don’t worry, you can set a password in the TickTick settings in addition to being able to sign in using one of the mentioned authentication methods.
Adding the TickTick integration to Home Assistant
The easiest way of setting up the TickTick custom component is (surprise) by using HACS (Home Assistant Community Store). Navigate to HACS in the Home Assistant web interface and select
Custom repositories from the more options icon in the top-right corner. Paste the following URL, select
Integration, and add the repository:
You should now be able to find TickTick in the list of available custom components in HACS. Once found, simply install it and restart Home Assistant to finish the process. As with every other custom component, HACS really alleviates the adding of custom components.
Integrating Home Assistant with TickTick
The next step is to configure the TickTick integration. To do so, select
Integrations in the configuration menu and click on the button to add a new integration. Search for TickTick in the list and select it. Enter your username (which should be your email) and password to proceed.
Congratulations, you can now add tasks to TickTick from Home Assistant. You can now use the service
ticktick.add_task. This service can, of course, be used in any automations or scripts. To add a due date and assign a project to your tasks you can simply add the following parameters:
title: This is a test! due_date: 2021-02-01 project: YOUR_PROJECT_ID
Finding the TickTick project ID
Figuring out what to enter as the project is a simple as looking at the URL when having the desired project opened. The URL should have the format
https://ticktick.com/webapp/#p/YOUR-PROJECT-ID/tasks. The string between
/tasks is the project’s ID.