Wekan

1. Overview

Wekan is an open-source Kanban platform for organizing work with boards, lists, cards, comments, and checklists. The GoInsight Wekan node lets workflows read and manage these resources through the Wekan REST API.

The node supports a complete board hierarchy:

• Discover boards and retrieve a board by its exact ID.
• Create, read, update, and delete lists and cards within a board.
• Create, read, and delete card comments and checklists.
• Retrieve, update, and delete checklist items.

2. Prerequisites

Before using this node, prepare a Wekan account that can access the target board and its child resources. Configure a Wekan API credential in GoInsight with the reachable base URL, username, and password for that account.

Most actions require identifiers from the Wekan hierarchy. Start with Get Boards, then use Get Lists, Get Cards, Get Checklists, or Get Card Comments to discover downstream IDs. Delete actions require explicit confirmation because they permanently remove source-system data.

3. Credentials

Create a Wekan API credential in GoInsight and provide the following values:

• BaseUrl: The Wekan service address, including the http:// or https:// scheme. Example: https://wekan.example.com.
• Username: The username of a Wekan account with access to the target resources.
• Password: The password for that Wekan account. The tool obtains a short-lived Wekan login token during execution and does not require callers to provide a token field.

The base URL must be reachable from the GoInsight runtime, not only from a developer workstation. The selected account must be a member of the target board when Wekan permission rules require membership.

4. Supported Operations

Summary

The Wekan node provides 24 actions across six resource types.

Total: 24 API operations. List actions return Page, Limit, Count, TotalCount, and HasMore. Wekan does not provide server-side pagination for these endpoints, so the tool loads the upstream collection and applies the requested page locally. Keep Limit bounded when a board may contain many resources.

Operation Details

Create Board

Creates a Wekan board through POST /api/boards. This action creates data and is not idempotent; check for an existing board before retrying.

Input Parameters:

• Title: Board title to create.

Options:

• Permission: Board permission level accepted by the Wekan server.
• Color: Board color value accepted by the Wekan server.
• Confirm: Set to true only after the caller confirms that a new board should be created.

Output:

• Board (object) and BoardId (string): The created board and its ID for Create List, Get Board, or other board-scoped actions.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Delete Board

Permanently deletes a board through DELETE /api/boards/{board}. Use Get Board first to verify the target because this action cannot be undone.

Input Parameters:

• BoardId: Exact board ID obtained from Get Boards, Create Board, or the Wekan UI.
• ConfirmDelete: Must be true to authorize the destructive operation.

Output:

• Board (object) and BoardId (string): The board returned by Wekan when available.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Board

Retrieves one board through GET /api/boards/{board} when the exact board ID is already known.

Input Parameters:

• BoardId: Exact board ID obtained from Get Boards, Create Board, or the Wekan UI.

Output:

• Board (object) and BoardId (string): Board metadata and the resolved board identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Boards

Lists boards accessible to the credential account through GET /api/users/{user}/boards. Use Get Board instead when a precise BoardId is already known.

Options:

• Page: One-based result page. Default is 1.
• Limit: Maximum number of boards returned after local pagination. Default is 100.

Output:

• Boards (object-array): Board records including _id and title; use _id as BoardId in downstream actions.
• Count, TotalCount, Page, Limit, and HasMore: Page metadata for the returned board collection.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Create List

Creates a list through POST /api/boards/{board}/lists. Check the existing board lists first when duplicate titles would be harmful.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• Title: List title to create.

Options:

• Confirm: Set to true only after the caller confirms that a new list should be created.

Output:

• List (object) and ListId (string): The created list and its ID for card actions.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Delete List

Permanently deletes a list through DELETE /api/boards/{board}/lists/{list}. Verify both parent and target IDs before calling.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Exact list ID obtained from Get Lists or Create List.
• ConfirmDelete: Must be true to authorize the destructive operation.

Output:

• List (object) and ListId (string): The deleted list response when available.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get List

Retrieves one list through GET /api/boards/{board}/lists/{list} when both parent and list IDs are known.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Exact list ID obtained from Get Lists or Create List.

Output:

• List (object) and ListId (string): List metadata and the resolved list identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Lists

Lists board lists through GET /api/boards/{board}/lists. Use Get List instead when an exact ListId is already known.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.

Options:

• Page: One-based result page. Default is 1.
• Limit: Maximum number of lists returned after local pagination. Default is 100.

Output:

• Lists (object-array): List records including _id and title; use _id as ListId in card actions.
• Count, TotalCount, Page, Limit, and HasMore: Page metadata for the returned list collection.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Create Card

Creates a card through POST /api/boards/{board}/lists/{list}/cards. Confirm the target list and check for duplicate cards before retrying.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Parent list ID obtained from Get Lists or Create List.
• Title: Card title to create.
• SwimlaneId: Wekan swimlane ID required by this API action for card placement.

Options:

• Description: Card description text.
• AuthorId: Optional Wekan user ID for the card author when the server accepts it.
• Confirm: Set to true only after the caller confirms that a new card should be created.

Output:

• Card (object) and CardId (string): The created card and its ID for comment and checklist actions.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Delete Card

Permanently deletes a card through DELETE /api/boards/{board}/cards/{card}. Use Get Card first when the target needs verification.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Parent list ID obtained from Get Lists or Create List.
• CardId: Exact card ID obtained from Get Cards or Create Card.
• ConfirmDelete: Must be true to authorize the destructive operation.

Output:

• Card (object) and CardId (string): The deleted card response when available.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Card

Retrieves one card through GET /api/boards/{board}/cards/{card}. Use Get Cards first when CardId is not known.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Parent list ID obtained from Get Lists or Create List.
• CardId: Exact card ID obtained from Get Cards or Create Card.

Output:

• Card (object) and CardId (string): Card metadata and the resolved card identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Cards

Lists cards through GET /api/boards/{board}/lists/{list}/cards. Use Get Card instead when an exact CardId is already known.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Parent list ID obtained from Get Lists or Create List.

Options:

• Page: One-based result page. Default is 1.
• Limit: Maximum number of cards returned after local pagination. Default is 100.

Output:

• Cards (object-array): Card records including _id, title, description, and list placement fields; use _id as CardId.
• Count, TotalCount, Page, Limit, and HasMore: Page metadata for the returned card collection.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Update Card

Updates a card through PUT /api/boards/{board}/cards/{card}. This action may overwrite selected fields, so read the current card first when conflicts matter.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• ListId: Parent list ID obtained from Get Lists or Create List.
• CardId: Exact card ID obtained from Get Cards or Create Card.
• Title: New card title.

Options:

• Description: New card description text.
• Confirm: Set to true after confirming the intended field changes.

Output:

• Card (object) and CardId (string): The updated card and its identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Create Card Comment

Creates a card comment through POST /api/boards/{board}/cards/{card}/comments. Repeating the request can create duplicate comments.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• Comment: Comment text to add to the card.

Options:

• AuthorId: Optional Wekan user ID for the comment author when the server accepts it.
• Confirm: Set to true only after the caller confirms that the comment should be created.

Output:

• Comment (object) and CommentId (string): The created comment and its ID.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Delete Card Comment

Permanently deletes a comment through DELETE /api/boards/{board}/cards/{card}/comments/{comment}.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• CommentId: Exact comment ID obtained from Get Card Comments or Create Card Comment.
• ConfirmDelete: Must be true to authorize the destructive operation.

Output:

• Comment (object) and CommentId (string): The deleted comment response when available.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Card Comment

Retrieves one comment through GET /api/boards/{board}/cards/{card}/comments/{comment}.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• CommentId: Exact comment ID obtained from Get Card Comments or Create Card Comment.

Output:

• Comment (object) and CommentId (string): Comment metadata and the resolved identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Card Comments

Lists comments attached to a card through GET /api/boards/{board}/cards/{card}/comments.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.

Options:

• Page: One-based result page. Default is 1.
• Limit: Maximum number of comments returned after local pagination. Default is 100.

Output:

• Comments (object-array): Comment records including _id, text, and author metadata; use _id as CommentId.
• Count, TotalCount, Page, Limit, and HasMore: Page metadata for the returned comment collection.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Create Checklist

Creates a checklist through POST /api/boards/{board}/cards/{card}/checklists. Check existing card checklists before retrying when duplicate titles matter.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• Title: Checklist title to create.

Options:

• Items: Optional checklist item content accepted by the Wekan API.
• Confirm: Set to true only after the caller confirms that a new checklist should be created.

Output:

• Checklist (object) and ChecklistId (string): The created checklist and its ID for item actions.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Delete Checklist

Permanently deletes a checklist through DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• ChecklistId: Exact checklist ID obtained from Get Checklists or Create Checklist.
• ConfirmDelete: Must be true to authorize the destructive operation.

Output:

• Checklist (object) and ChecklistId (string): The deleted checklist response when available.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Checklist

Retrieves one checklist through GET /api/boards/{board}/cards/{card}/checklists/{checklist}.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• ChecklistId: Exact checklist ID obtained from Get Checklists or Create Checklist.

Output:

• Checklist (object) and ChecklistId (string): Checklist metadata and the resolved identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Checklists

Lists checklists attached to a card through GET /api/boards/{board}/cards/{card}/checklists.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.

Options:

• Page: One-based result page. Default is 1.
• Limit: Maximum number of checklists returned after local pagination. Default is 100.

Output:

• Checklists (object-array): Checklist records including _id, title, and item metadata; use _id as ChecklistId.
• Count, TotalCount, Page, Limit, and HasMore: Page metadata for the returned checklist collection.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Delete Checklist Item

Permanently deletes a checklist item through DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• ChecklistId: Parent checklist ID obtained from Get Checklists or Create Checklist.
• ChecklistItemId: Exact item ID obtained from Get Checklist Item or the checklist data returned by Get Checklists.
• ConfirmDelete: Must be true to authorize the destructive operation.

Output:

• ChecklistItem (object) and ChecklistItemId (string): The deleted item response when available.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Get Checklist Item

Retrieves one checklist item through GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• ChecklistId: Parent checklist ID obtained from Get Checklists or Create Checklist.
• ChecklistItemId: Exact item ID obtained from Get Checklists or the Wekan UI.

Output:

• ChecklistItem (object) and ChecklistItemId (string): Checklist item metadata and the resolved identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

Update Checklist Item

Updates a checklist item through PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}. Verify the current item first when changing completion state or title.

Input Parameters:

• BoardId: Parent board ID obtained from Get Boards or Create Board.
• CardId: Target card ID obtained from Get Cards or Create Card.
• ChecklistId: Parent checklist ID obtained from Get Checklists or Create Checklist.
• ChecklistItemId: Exact item ID obtained from Get Checklists or the Wekan UI.
• Title: New checklist item title.

Options:

• IsFinished: Completion state. Use true for completed and false for incomplete.
• Confirm: Set to true after confirming the intended update.

Output:

• ChecklistItem (object) and ChecklistItemId (string): The updated item and its identifier.
• Success, Hint, Retryable, Summary, OriginalStatusCode, StatusCode, and ErrorMessage: Standard execution result fields.

5. Example Usage

Use Get Boards as the first discovery step in a Wekan workflow.

1. Add a Wekan Get Boards action to the workflow canvas.
2. Select a Wekan API credential whose base URL is reachable from GoInsight.
3. Set Page to 1 and set a bounded Limit, such as 20.
4. Run the action and inspect the returned Boards array.
5. Use the _id value from a returned board as BoardId in Get Lists, Get Board, Create List, or other board-scoped actions.

For a write workflow, discover and inspect the parent hierarchy first, then call the create or update action with Confirm set to true. For a delete workflow, call the matching Get action to verify the target and set ConfirmDelete to true only after explicit user confirmation.

6. FAQs

Why does the tool report that BaseUrl is invalid?

BaseUrl must begin with http:// or https://, and it must be reachable from the GoInsight runtime. A workstation-only address or a URL without the scheme is invalid.

Why does a list action use local pagination?

The relevant Wekan API endpoints return complete collections without server-side page parameters. The tool applies Page and Limit after receiving the collection. Use a small limit for large boards.

Why do create and delete actions require confirmation fields?

Create actions can produce duplicates after retries, and delete actions are destructive. Confirm and ConfirmDelete make the caller acknowledge those side effects before the request is sent.

How can I find a required ID?

Use the nearest list or create action in the hierarchy. For example, Get Boards returns BoardId candidates, Get Lists returns ListId candidates, Get Cards returns CardId candidates, and Get Checklists returns ChecklistId candidates.

7. Official Documentation

Wekan REST API documentation