Vikunja Trigger icon

Vikunja Trigger

Starts the workflow when Vikunja events occur

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 creation, deletion, updates, comments, attachments, and sharing actions. When one of the selected events happens in the specified project, the node activates the workflow.

Common scenarios include automating notifications, synchronizing data with other systems, or triggering follow-up actions when tasks are updated or projects change. For example, you could use this node to start a workflow that sends an email alert whenever a task is assigned or a comment is added.

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. 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 the event includes any binary data (not indicated in the source), it would be handled accordingly, but this node primarily deals with 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 uses internal helper functions to make authenticated API requests to Vikunja.
  • The webhook URL must be accessible by the Vikunja server to deliver event notifications.

Troubleshooting

  • Webhook registration failure: If the node cannot create or find the webhook on Vikunja, ensure the API credentials are correct and have sufficient permissions. Also, verify that the webhook URL is publicly reachable.
  • No events triggering the workflow: Confirm that the correct project ID is set and that the desired events are selected. Check Vikunja's webhook delivery logs to see if events are sent.
  • Error responses from Vikunja API: These may indicate invalid parameters or authentication issues. Review the node's configuration and API key validity.
  • Duplicate triggers: If multiple webhooks exist for the same project and URL, it might cause duplicate executions. The node attempts to detect existing webhooks to avoid duplicates.

Links and References

Discussion