Overview
This node acts as a trigger for workflows based on events occurring in a Vikunja project management system. It listens for specific webhook events related to projects and tasks, such as task creation, updates, deletions, comments, attachments, and project sharing or updates. When one of the selected events happens in the specified project, the node activates the workflow.
Common scenarios where this node is beneficial include:
- Automating notifications or follow-up actions when tasks are created or updated.
- Syncing project changes with other tools or databases.
- Triggering custom workflows when a project is shared or deleted.
- Monitoring task comments or attachments to initiate further processing.
For example, you could use this node to start a workflow that sends an email alert whenever a new task is assigned or a comment is added to a task within a particular project.
Properties
| Name | Meaning |
|---|---|
| Project ID | The identifier of the project to monitor. You can select from a list or specify a numeric ID. |
| Events | The webhook events that will trigger this node. Multiple events can be selected. Available options include: project.deleted, project.shared.team, project.shared.user, project.updated, task.assignee.created, task.assignee.deleted, task.attachment.created, task.attachment.deleted, task.comment.created, task.comment.deleted, task.comment.edited, task.created, task.deleted, task.relation.created, task.relation.deleted, task.updated. |
Output
The node outputs JSON data representing the webhook payload received from Vikunja when one of the subscribed events occurs. This JSON contains detailed information about the event, such as the affected project or task and the nature of the change.
If binary data were involved (e.g., file attachments), it would be included accordingly, but this node primarily handles JSON event data.
Dependencies
- Requires an API key credential for authenticating with the Vikunja API.
- Needs network access to the Vikunja instance to register and receive webhooks.
- The node manages webhook registration by creating, checking, and deleting webhooks on the specified project via the Vikunja API.
Troubleshooting
- Webhook Registration Failures: If the node cannot create or find the webhook on the Vikunja server, ensure the API credentials are correct and have sufficient permissions.
- No Trigger on Events: Verify that the selected events match those emitted by Vikunja and that the project ID is correct.
- Webhook URL Accessibility: The webhook URL must be publicly accessible by Vikunja; otherwise, events will not reach the node.
- API Request Errors: Network issues or incorrect API endpoint configurations may cause errors during webhook management calls.
Links and References
- Vikunja Official Website
- Vikunja API Documentation (for details on webhook events and API usage)