Documentation

n8n-nodes-vikunja

License: MIT

This is an n8n community node package for Vikunja - the open-source, self-hosted To-Do app.

Vikunja is a powerful task management application that can be self-hosted. This package provides comprehensive integration for n8n automation workflows.

Features

  • 14 Resources: Tasks, Projects, Labels, Teams, Buckets, Views, Comments, Attachments, Filters, Webhooks, Users, Notifications, Subscriptions, and API Tokens
  • Complete CRUD Operations: Create, Read, Update, Delete for all resources
  • Webhook Triggers: Real-time automation based on Vikunja events
  • AI Agent Tools: 9 specialized tools for use with n8n AI Agent node
  • Advanced Filtering: Full support for Vikunja's filter query syntax

Installation

Community Nodes (Recommended)

  1. Go to Settings > Community Nodes
  2. Click Install
  3. Enter n8n-nodes-vikunja
  4. Click Install

Manual Installation

cd ~/.n8n/nodes
npm install n8n-nodes-vikunja

Quick Start

  1. Add Credentials

    • Go to Credentials > New
    • Search for "Vikunja API"
    • Enter your Vikunja host URL and API token
  2. Use in Workflow

    • Add "Vikunja" node
    • Select resource and operation
    • Configure parameters
    • Execute!

Nodes

Vikunja

Main node with all operations:

Resource Operations
Task Create, Get, Update, Delete, Bulk Update, Assignees, Labels, Relations
Project Create, Get, Update, Delete, Duplicate, Team/User sharing
Label Create, Get, Update, Delete
Team Create, Get, Update, Delete, Members management
Bucket Create, Get, Update, Delete (Kanban)
View Create, Get, Update, Delete (List/Gantt/Table/Kanban)
Comment Create, Get, Update, Delete
Attachment Upload, Download, Delete
Filter Create, Get, Update, Delete
Webhook Create, Get, Update, Delete
User Get current, Search, Settings
Notification Get, Mark read
Subscription Subscribe, Unsubscribe
Token Create, Delete

Vikunja Trigger

Webhook-based trigger for real-time events:

  • Task events (created, updated, deleted)
  • Comment events
  • Assignee events
  • Project events
  • Team events

AI Agent Tools

Specialized tools for AI workflows:

  • Create Task
  • Get Task
  • List Tasks
  • Update Task
  • Complete Task
  • Delete Task
  • List Projects
  • Create Project
  • Add Comment

Documentation

See docs/README.md for complete documentation.

Requirements

  • n8n v1.0.0 or later
  • Vikunja instance with API access
  • API Token or JWT authentication

Development

# Clone
git clone <repository-url>
cd n8n-nodes-vikunja

# Install dependencies
npm install

# Build
npm run build

# Development mode
npm run dev

License

MIT

Credits

  • Vikunja - The open-source To-Do app
  • n8n - Workflow automation tool

Discussion