This Home Assistant integration allows you to sync tasks from your Vikunja instance to Home Assistant. You can view and manage tasks as entities and sensors within the Home Assistant UI.

• Fetch tasks from Vikunja and display them as entities in Home Assistant
• Supports viewing and completing tasks. (more to come)
• Easy integration with Home Assistant UI for task management

1. Open HACS. Click the ... in the top right and "Custom Repositories"

2. Add the link to this repository and select "Integration" from the dropdown.

3. Then install Vikunja integration.

1. Open Home Assistant and go to Settings > Integrations.
2. Click the + icon in the bottom right corner to add an integration.
3. Search for Vikunja in the list and select it.
4. Follow the prompts to complete the installation.

1. Download the integration repository from GitHub.
2. Place the custom_components/vikunja folder inside the custom_components/ directory in your Home Assistant configuration folder.
   • The folder structure should look like this:

     homeassistant/
     └── custom_components/
         └── vikunja/
     

3. Restart Home Assistant.

Once the integration is installed, you need to provide your Vikunja instance's URL and API key.

1. Go to your Vikunja instance at https://vikunja.io/ or your self-hosted Vikunja.
2. Log in to your account.
3. Navigate to the API Keys section in your Vikunja user settings.
4. Create a new API key. Giving some subset of access:
   • An expiration you'd prefer. I set mine to 10 years.
   • Projects (the integration fetches projects first, then tasks for projects)
     • Read All
     • Read One
   • Tasks
     • Create (optional if you want to create more via Todo)
     • Delete (optional if you want to delete via Todo)
     • Read All (required)
     • Read One (required)
     • Update (required)
5. Copy the generated API key.

This integration can be setup from the UI, so simply go to "Devices" -> "Add integration" and search for Vikunja.

Or use this button:

The API key needs permission to read and update tasks. This allows Home Assistant to fetch and update task data. Ensure that the key has sufficient privileges for accessing the task-related endpoints.

These are the permissions I have that work:

After successfully setting up the integration, Vikunja tasks will automatically appear as sensors and entities in Home Assistant. You can view their status, modify task attributes, and automate based on task data.

You will also find that each "Project" in Vikunja has created a Todo List in HA.

And you can Create/Update/Complete tasks from the Todo section

Note I am considering committing this to become a core home assistant integration but using HACS as a quicker to market solution.

If you'd like to contribute to this project, feel free to submit a pull request.