Planka icon

Planka

Interact with Planka API

Overview

The Add Label to Card operation in the Planka n8n node allows you to attach an existing label to a specific card within your Planka project management system. This is useful for categorizing, prioritizing, or visually organizing cards (tasks) on your boards.

Common scenarios:

  • Automatically tagging new cards with priority or status labels.
  • Adding workflow-specific labels based on triggers or conditions in your automation.
  • Integrating with other systems to synchronize tags/labels.

Example use cases:

  • When a support ticket is escalated, automatically add a "High Priority" label to its corresponding Planka card.
  • After a code review passes, add a "Ready for QA" label to the development task card.

Properties

Name Type Meaning
Card ID String The unique identifier of the card to which the label will be added.
Label ID String The unique identifier of the label to add to the card.

Output

The output will be a JSON object representing the result of the API call to add the label to the card. Typically, this includes details about the updated card or the association between the card and the label. The exact structure depends on the Planka API response, but you can expect fields such as:

{
  "id": "string",
  "cardId": "string",
  "labelId": "string",
  // ...other card-label association details
}

If the operation fails and "Continue On Fail" is enabled, the output will include an error message:

{
  "error": "Error message text"
}

Dependencies

  • Planka API: Requires access to a running Planka instance.
  • 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 Card ID or Label ID: If either ID does not exist, the API will return an error.
  • Missing Permissions: The user associated with the API key may lack permission to modify the card or label.
  • Network/API Errors: Connectivity issues or incorrect API base URL configuration.

Typical error messages:

  • "Card not found" or "Label not found": Check that both IDs are correct and exist in Planka.
  • "Unauthorized": Ensure your API credentials are valid and have sufficient permissions.
  • "An unknown error occurred": This generic message appears if the error is not specifically handled; check logs or API responses for more detail.

Links and References


Discussion