Workspace icon

Workspace

Get and change data from Workspace API

Overview

The node interacts with a Workspace API to manage various resources, including Kanban boards. Specifically, the "Toggle Kanban Checklist Entry" operation allows users to update the status of a checklist item within a Kanban card. This is useful for workflow automation where task progress tracking on Kanban cards needs to be programmatically updated, such as marking checklist items as done or pending based on external triggers or conditions.

Practical examples include:

  • Automatically marking a checklist item as completed when a related issue is resolved in another system.
  • Resetting checklist statuses at the start of a new sprint or project phase.
  • Synchronizing checklist statuses between different project management tools.

Properties

Name Meaning
Kanban Card ID The unique identifier of the Kanban card containing the checklist item (required).
Checklist Entry ID The unique identifier of the checklist item to update (required).
Status The new status for the checklist item. Use "done" to mark it as completed (required).

These properties are grouped under "Update Fields" and must be provided to perform the checklist status update.

Output

The node outputs JSON data representing the result of the update operation on the Kanban checklist entry. This typically includes confirmation of the updated status and possibly the updated checklist item details. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential and tenant information to authenticate requests against the Workspace API.
  • The base URL for the API is configurable via credentials.
  • The node depends on the Workspace API being accessible and properly configured to accept updates to Kanban checklist entries.

Troubleshooting

  • Missing Required Fields: Errors may occur if Kanban Card ID, Checklist Entry ID, or Status are not provided or are invalid. Ensure all required fields are correctly filled.
  • Authentication Failures: If the API key or tenant credentials are incorrect or missing, the node will fail to authenticate. Verify credentials in n8n settings.
  • API Endpoint Issues: Network errors or incorrect base URL configuration can cause request failures. Confirm the API URL and network connectivity.
  • Invalid Status Values: Using unsupported status values other than "done" might lead to errors or ignored updates. Use documented status values only.

Links and References

Discussion