Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to create new projects within a user's task management environment. It allows users to specify details such as the project title, parent project, and various optional attributes like description, color, and status flags (archived or favorite). This node is useful for automating project creation workflows, organizing tasks hierarchically, or setting up new projects programmatically based on external triggers or data.

Practical examples include:

  • Automatically creating a new project when a new client is onboarded.
  • Duplicating an existing project structure by specifying a parent project.
  • Setting up projects with predefined colors and identifiers for consistent task tracking.

Properties

Name Meaning
Parent Project Title or ID The parent project under which the new project will be created. Can be selected from a list or specified by ID.
Project Title The name/title of the new project. This is a required field.
Archived Whether the project should be marked as archived (true/false).
Description A textual description providing more details about the project.
Favorite Whether the project should be marked as a favorite (true/false).
Identifier A unique short identifier for the project, used to build task identifiers.
Project Color The color associated with the project, represented as a hex color code (e.g., #000000).

Output

The node outputs JSON data representing the newly created project as returned by the Vikunja API. This typically includes fields such as the project ID, title, description, color, status flags, and any other metadata set during creation.

If the node supports binary data output (not indicated in the provided code), it would typically relate to attachments or files associated with the project, but no such functionality is evident here.

Dependencies

  • Requires an API key credential for authenticating with the Vikunja API.
  • The base URL for the Vikunja API must be configured in the node credentials.
  • The node depends on the Vikunja API being accessible and properly configured to accept project creation requests.

Troubleshooting

  • Common Issues:
    • Invalid or missing API credentials can cause authentication failures.
    • Providing an invalid parent project ID may result in errors or failure to create the project.
    • Required fields like "Project Title" must be filled; otherwise, the API will reject the request.
  • Error Messages:
    • Authentication errors usually indicate issues with the API key or endpoint URL.
    • Validation errors from the API may mention missing required fields or invalid values.
  • Resolutions:
    • Verify that the API key and base URL are correctly set in the node credentials.
    • Ensure the parent project exists if specifying one.
    • Double-check all required properties before execution.

Links and References

Discussion