Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to update an existing webhook associated with a project. It allows users to modify the webhook's target URL, secret for signing requests, and the events that trigger the webhook. This is useful in scenarios where you want to change how your application receives notifications from Vikunja about project or task changes without creating a new webhook.

Practical examples:

  • Updating the URL where webhook payloads are sent after migrating your backend service.
  • Adding or removing specific event triggers to control which actions in Vikunja cause webhook calls.
  • Changing the secret used to sign webhook requests for enhanced security.

Properties

Name Meaning
Project Title or ID The project to operate on. Choose from a searchable list of projects or specify a project ID directly.
Webhook ID The identifier of the webhook to update. Must be specified as a number.
Webhook Target URL The new URL where webhook requests will be sent. Required field.
Secret Optional secret string used to sign webhook requests using HMAC for verification purposes.
Events List of webhook event types that should trigger this webhook. Multiple options can be selected:
- 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 updated webhook object as returned by the Vikunja API. This typically includes details such as the webhook ID, target URL, secret (if stored), subscribed events, and metadata about the webhook.

If the node supports binary data output, it is not indicated here; the focus is on JSON response data.

Dependencies

  • Requires an API key credential for authenticating with the Vikunja API.
  • Needs the base URL of the Vikunja instance configured in the node credentials.
  • Uses HTTP requests with JSON content type to communicate with the Vikunja API.

Troubleshooting

  • Invalid Webhook ID: If the webhook ID does not exist or is incorrect, the API will likely return a 404 error. Verify the webhook ID before updating.
  • Unauthorized Access: Missing or invalid API credentials will cause authentication errors. Ensure the API key is valid and has sufficient permissions.
  • Invalid URL Format: The webhook target URL must be a valid URL. Invalid URLs may cause request failures.
  • Empty Required Fields: Omitting required fields like the project or target URL will prevent the update operation.
  • Event Selection Issues: Selecting no events or invalid event names might result in unexpected behavior or errors. Always select at least one valid event.

Links and References

Discussion