Planka icon

Planka

Interact with Planka API

Overview

The "Add Member to Board" operation for the 📋 BOARD resource in this n8n node allows you to add a user as a member to a specific board within Planka, an open-source project management tool. This is useful for automating team collaboration workflows, such as onboarding new team members to project boards or managing access rights programmatically.

Practical scenarios:

  • Automatically adding new employees to relevant project boards when they join a team.
  • Granting temporary or permanent access to external collaborators on a board.
  • Managing board roles (Admin/Editor) for users based on workflow logic.

Properties

Name Type Meaning
Board ID String The unique identifier of the board to which the member will be added.
User ID String The unique identifier of the user who will be added as a member to the board.
Role Options The role assigned to the member on the board. Possible values: "Admin", "Editor".

Output

The output will be a JSON object representing the newly created board membership. While the exact structure depends on the Planka API response, it typically includes details such as:

{
  "id": "membershipId",
  "boardId": "boardId",
  "userId": "userId",
  "role": "admin",
  // ...other membership properties
}
  • id: The unique identifier of the board membership.
  • boardId: The board to which the user was added.
  • userId: The user who was added.
  • role: The assigned role ("admin" or "editor").
  • Additional fields may be present depending on the Planka API.

Dependencies

  • Planka API: Requires access to a running Planka instance with API enabled.
  • API Credentials: You must configure the plankaApi credentials in n8n for authentication.
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid Board ID/User ID: If the provided IDs do not exist, the API will return an error.
  • Insufficient Permissions: The API credentials used must have permission to manage board memberships.
  • Duplicate Membership: Attempting to add a user who is already a member may result in an error.

Error messages and resolutions:

  • "Board not found": Check that the Board ID is correct and exists in Planka.
  • "User not found": Verify the User ID is valid.
  • "User is already a member": Ensure the user isn't already part of the board before adding.
  • "Unauthorized": Confirm your API credentials have sufficient permissions.

Links and References

Discussion