Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to create webhooks for projects. It allows users to specify a target URL that will receive webhook event notifications related to project activities. This is useful for automating workflows or triggering external processes when certain events occur in a project, such as task creation, updates, deletions, or changes in project sharing.

Practical examples include:

  • Automatically notifying a chat system when a new task is created.
  • Triggering CI/CD pipelines when a project is updated.
  • Logging project activity externally by receiving webhook calls on specific events.

Properties

Name Meaning
Project Title or ID The project to operate on. Can be selected from a searchable list of projects or specified by its ID.
Webhook Target URL The URL where webhook event payloads will be sent.
Secret Optional secret used to sign webhook requests using HMAC for security verification.
Events List of webhook event types that will trigger this webhook. Options include various project and task events such as project.deleted, task.created, task.updated, 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 other metadata provided by the API.

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 credential.
  • Needs the base URL of the Vikunja instance configured in the node credentials.
  • 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 ID or select from the list.
  • Invalid Webhook Target URL: Ensure the target URL is reachable and correctly formatted; otherwise, webhook delivery will fail.
  • Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Missing Required Fields: The node requires at least the project and target URL; missing these will cause validation errors.
  • HMAC Signature Issues: If using the secret for signing, ensure the receiving endpoint correctly verifies the signature according to Vikunja's documentation.

Links and References

Discussion