Planka

Interact with Planka API

Actions46

Overview

The Planka n8n node for the operation Create Project under the resource 🏢 PROJECT allows users to create a new project in their Planka workspace via the Planka API. This is useful for automating project creation as part of onboarding workflows, project management automation, or integrating Planka with other systems (e.g., when a new client is added in a CRM, automatically create a corresponding project in Planka).

Practical examples:

Automatically create a new Planka project when a new deal is closed in your sales pipeline.
Set up standardized project backgrounds and types for different departments by automating project creation.
Integrate with form submissions to generate projects based on user input.

Properties

Name	Type	Meaning
Name	String	Name of the project. (Required)
Background Name	String	Name of the background for the project.
Background Type	Options	Type of background; can be "Gradient" or "Image".
Background Image	String	URL of the background image to use if "Background Type" is "Image".

Output

The node returns the created project's data in the json field. The structure typically includes details such as:

{
  "id": "string",
  "name": "string",
  "background": "string",
  "backgroundType": "string",
  "backgroundImage": "string",
  // ...other project fields as returned by the Planka API
}

The exact fields depend on the Planka API's response for project creation.
Each output item corresponds to one created project.

Dependencies

External Service: Requires access to a running Planka instance with API enabled.
Authentication: Needs valid Planka API credentials configured in n8n under the credential type plankaApi.
n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common Issues:

Missing Required Fields: If "Name" is not provided, the node will throw an error.
Invalid Credentials: If the Planka API credentials are incorrect or missing, authentication errors will occur.
API Endpoint Unreachable: Network issues or incorrect Planka base URL may cause connection failures.
Invalid Background Image URL: If "Background Type" is set to "Image" but the "Background Image" URL is invalid or inaccessible, the project may be created without the intended background.

Error Messages:

"error": "Request failed with status code 401" – Check your API credentials.
"error": "Missing required parameter: name" – Ensure the "Name" property is filled.
"error": "Network Error" – Verify network connectivity and Planka server availability.