2023-10-24 17:16:00 +00:00
# n8n-nodes-vikunja
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
This is an n8n community node. It lets you use Vikunja in your n8n workflows.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
Vikunja is an open-source, self-hostable to-do and productivity application.
Check out [our website ](https://vikunja.io/ ) for more information.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
[n8n ](https://n8n.io/ ) is a [fair-code licensed ](https://docs.n8n.io/reference/license/ ) workflow automation platform.
2023-10-23 08:46:53 +00:00
2023-10-24 17:20:59 +00:00
* [Installation ](#installation )
* [Operations ](#operations )
* [Credentials ](#credentials )
* [Compatibility ](#compatibility )
* [Development ](#development )
* [Resources ](#resources )
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
## Installation
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
Follow the [installation guide ](https://docs.n8n.io/integrations/community-nodes/installation/ ) in the n8n community nodes documentation.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
## Operations
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
This node supports all operations supported by Vikunja API tokens.
You can see a full list of possible actions when creating a token in Vikunja.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
It also allows you to trigger n8n workflows by Vikunja webhooks.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
## Credentials
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
The only supported authentication method for this node are API tokens.
On your Vikunja instance, head over to *Settings > API Tokens* and create a new token.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
In n8n, create credentials as you usually would.
Enter the API token created previously and the API url.
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
## Compatibility
2023-10-23 08:46:53 +00:00
2023-10-24 17:16:00 +00:00
Tested with n8n Version 1.9.3.
2023-10-24 17:20:59 +00:00
## Development
You need npm and NodeJS installed.
* Install dependencies with `npm i`
* Build the node with `npm run build`
* Check for lint errors with `npm run lint` and fix them with `npm run lintfix`
* To release a new version in the npm registry, run `npm publish`
2023-10-24 17:25:41 +00:00
* To test the node, build the node with `npm run build` , then while in the project directory run `export N8N_CUSTOM_EXTENSIONS=$PWD` and start n8n with the `n8n` command. You should now be able to find the node when searching for it.
2023-10-24 17:20:59 +00:00
2023-10-24 17:16:00 +00:00
## Resources
* [n8n community nodes documentation ](https://docs.n8n.io/integrations/community-nodes/ )
* [Vikunja n8n Docs ](https://vikunja.io/docs/n8n )
* [Vikunja General Docs ](https://vikunja.io/docs/ )