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 project and configure a webhook target URL that will receive notifications when certain events occur within that project. This is useful for automating workflows, triggering external processes, or syncing data in real-time based on project changes.

Common scenarios include:

  • Notifying an external system when tasks are created or updated in a project.
  • Triggering CI/CD pipelines when a project is shared or deleted.
  • Logging or auditing project-related events externally.

Example: Automatically send task update notifications to a chat application by creating a webhook that listens to task.updated events for a specific project.

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 with 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 like the webhook ID, target URL, subscribed events, and any metadata related to the webhook configuration.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Vikunja API.
  • Needs the base URL of the Vikunja instance configured in the credentials.
  • The node uses HTTP requests to interact with the Vikunja REST API endpoints.

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 it from the provided list.
  • Invalid Webhook Target URL: Ensure the target URL is reachable and correctly formatted (including protocol).
  • Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Empty Events List: The webhook requires at least one event to subscribe to; ensure you select one or more events.
  • Secret Misconfiguration: If using the secret for signing, verify that the receiving endpoint can validate the HMAC signature as per Vikunja's documentation.

Links and References

Discussion