Skip to main content

Wekan

The Wekan node allows you to automate work in Wekan, and integrate Wekan with other applications. Robbot Automation has built-in support for a wide range of Wekan credentials, including creating, updating, deleting, and getting boards and cards.

On this page, you'll find a list of operations the Wekan node supports and links to more resources.

!!! note "Credentials" Refer to Wekan credentials for guidance on setting up authentication.

!!! note "Examples and templates" For usage examples and templates to help you get started, take a look at Robbot Automation's Wekan list.

Basic Operations​

  • Board
    • Create a new board
    • Delete a board
    • Get the data of a board
    • Get all user boards
  • Card
    • Create a new card
    • Delete a card
    • Get a card
    • Get all cards
    • Update a card
  • Card Comment
    • Create a comment on a card
    • Delete a comment from a card
    • Get a card comment
    • Get all card comments
  • Checklist
    • Create a new checklist
    • Delete a checklist
    • Get the data of a checklist
    • Returns all checklists for the card
  • Checklist Item
    • Delete a checklist item
    • Get a checklist item
    • Update a checklist item
  • List
    • Create a new list
    • Delete a list
    • Get the data of a list
    • Get all board lists

Example Usage​

This workflow allows you to create a board and two lists called To Do and Done using the Wekan node. It also allows you to create a card and update the list ID of the card, enabling you to move it from the To Do list to the Done list. You can also find the workflow on Robbot Automation. This example usage workflow uses the following nodes.

1. Start node​

The start node exists by default when you create a new workflow.

2. Wekan node (create: board)​

This node will create a board called Documentation in Wekan. To create a board with a different name, you can enter the name of your board instead.

  1. First of all, you'll have to enter credentials for the Wekan node. You can find out how to do that here.

  2. Select 'Board' from the Resource dropdown list.

  3. Enter Documentation in the Title field.

  4. Select the owner of the board from the Owner dropdown list.

  5. Click on Save to run the node.

3. Wekan1 node (create: list)​

This node will create a list with the title To Do in the Documentation board, which was created using the previous node.

  1. Select the credentials that you entered in the previous node.
  2. Select 'List' from the Resource dropdown list.
  3. Click on the gears icon next to the Board ID field and click on Add Expression.
  4. Select the following in the Variable Selector section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan"].json["_id"]}}.
  5. Enter To Do in the Title field.
  6. Click on Save to run the node.

4. Wekan2 node (create: list)​

This node will create a list with the title Done in the Documentation board, which was created using the Wekan node.

  1. Select the credentials that you entered in the previous node.
  2. Select 'List' from the Resource dropdown list.
  3. Click on the gears icon next to the Board ID field and click on Add Expression.
  4. Select the following in the Variable Selector section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan"].json["_id"]}}.
  5. Enter Done in the Title field.
  6. Click on Save to run the node.

5. Wekan3 node (create: card)​

This node will create a card in the Documentation board under the list titled To Do, which was created using the Wekan1 node.

  1. Select the credentials that you entered in the previous node.
  2. Click on the gears icon next to the Board ID field and click on Add Expression.
  3. Select the following in the Variable Selector section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan"].json["_id"]}}.
  4. Click on the gears icon next to the List ID field and click on Add Expression.
  5. Select the following in the Variable Selector section: Nodes > Wekan1 > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan1"].json["_id"]}}.
  6. Enter Document Wekan node in the Title field.
  7. Select 'Default' from the Swimlane ID dropdown list.
  8. Select an author from the Author ID dropdown list.
  9. Click on Save to run the node.

6. Wekan4 node (update: card)​

This node will update the list ID of the card created by the previous node and move it from the To Do list to the Done list.

  1. Select the credentials that you entered in the previous node.
  2. Select 'Update' from the Operation dropdown list.
  3. Click on the gears icon next to the Board ID field and click on Add Expression.
  4. Select the following in the Variable Selector section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan"].json["_id"]}}.
  5. Click on the gears icon next to the List ID field and click on Add Expression.
  6. Select the following in the Variable Selector section: Nodes > Wekan1 > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan1"].json["_id"]}}.
  7. Click on the gears icon next to the Card ID field and click on Add Expression.
  8. Select the following in the Variable Selector section: Nodes > Wekan3 > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan3"].json["_id"]}}.
  9. Click on the Add Field button and select 'List ID'.
  10. Click on the gears icon next to the List ID field and click on Add Expression.
  11. Select the following in the Variable Selector section: Nodes > Wekan2 > Output Data > JSON > _id. You can also add the following expression: {{$node["Wekan2"].json["_id"]}}.
  12. Click on Save to run the node.

FAQs​

How to load all the parameters for the node?​

To load all the parameters, for example, Author ID, you need to give admin permissions to the user. Refer to the Wekan documentation to learn how to change permissions.