Planka icon

Planka

Interact with Planka API

Overview

The Create Board Label operation in the Planka n8n node allows you to create a new label on a specific board within your Planka workspace. Labels are useful for categorizing and visually distinguishing cards on a board, such as marking tasks by priority, status, or type.

Common scenarios:

  • Automating the creation of standardized labels when setting up new boards.
  • Integrating with other systems to dynamically generate labels based on external triggers (e.g., creating a "High Priority" label when a critical issue is detected).
  • Ensuring consistent color-coding and naming conventions across multiple boards.

Practical example:
When a new project board is created via automation, this node can immediately add labels like "Bug", "Feature", or "In Progress" with predefined colors, so team members can start organizing cards right away.


Properties

Name Type Meaning
Board ID String The unique identifier of the board where the label will be created.
Name String The name of the label to be created (e.g., "Urgent", "To Do").
Color String The color of the label in hexadecimal format (e.g., "#FF0000" for red).

Output

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

{
  "id": "labelId",
  "name": "Label Name",
  "color": "#4680FF",
  "boardId": "boardId",
  // ...other metadata fields
}
  • id: Unique identifier of the label.
  • name: Name of the label.
  • color: Hexadecimal color code of the label.
  • boardId: Identifier of the board the label belongs to.

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.

Troubleshooting

Common issues:

  • Invalid Board ID: If the provided Board ID does not exist, the API will return an error.
  • Color Format Error: The color must be a valid hexadecimal string (e.g., "#4680FF").
  • Missing Required Fields: Omitting required properties (Board ID, Color) will result in validation errors.

Error messages and resolutions:

  • "Board not found": Check that the Board ID is correct and exists in your Planka instance.
  • "Invalid color format": Ensure the color property starts with "#" and is followed by six hexadecimal digits.
  • "Missing required parameter": Make sure all required fields are filled in the node configuration.

Links and References

Discussion