Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to manage webhooks related to projects. Specifically, the "Webhook - Create" operation allows users to create a new webhook for a specified project. Webhooks are useful for receiving real-time notifications about events occurring in the project, such as task creation, updates, deletions, comments, and sharing changes.

Common scenarios include:

  • Automating workflows by triggering external processes when tasks or projects change.
  • Synchronizing data between Vikunja and other systems upon specific events.
  • Monitoring project activity without polling the API continuously.

For example, you could create a webhook that notifies your CI/CD system whenever a task is updated, or trigger a Slack message when a project is shared with a team.

Properties

Name Meaning
Project Title or ID The target project where the webhook will be created. You can select from a searchable list of projects or specify the project ID directly.
Webhook Target URL The URL endpoint that will receive the webhook POST requests when the specified events occur.
Secret An optional secret string used to sign webhook requests with HMAC for security verification.
Events The list of webhook event types that will trigger this webhook. Options include various project and task-related events such as project.deleted, task.created, task.comment.edited, etc.

Output

The node outputs JSON data representing the created webhook object as returned by the Vikunja API. This typically includes details such as the webhook ID, target URL, subscribed events, and any metadata associated with the webhook.

If the node supports binary data output (not indicated here), it would represent the webhook payload or related files, but this node primarily deals with JSON data.

Dependencies

  • Requires an active connection to the Vikunja API via an API key or token configured in n8n credentials.
  • The base URL for the Vikunja instance must be set correctly in the credential configuration.
  • No additional external services are required beyond the Vikunja API.

Troubleshooting

  • Invalid Project ID or Not Found: If the specified project does not exist or the ID is incorrect, the API will return an error. Verify the project selection or ID.
  • Unauthorized / Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to create webhooks.
  • Invalid Webhook Target URL: The target URL must be reachable and accept POST requests. Invalid URLs may cause webhook delivery failures.
  • Empty Events List: Creating a webhook without selecting any events may result in no triggers firing. Always select at least one event.
  • Secret Misconfiguration: If using the secret for signing, ensure your receiving endpoint verifies the signature correctly; otherwise, webhook requests might be rejected.

Links and References

Discussion