Plane icon

Plane

Consume Plane API

Actions63

Overview

This node interacts with the Plane API to manage issue properties within a project management context. Specifically, for the "Issue Property" resource and the "Create" operation, it allows users to create custom properties for issue types in a given project. These properties can be used to extend issue metadata with additional structured information such as dropdown options, numbers, text, or dates.

Common scenarios where this node is beneficial include:

  • Defining custom fields for issues to capture specific data relevant to your workflow.
  • Creating dropdown lists (options) for categorizing issues.
  • Adding numeric, textual, or date-based attributes to issues for better tracking and filtering.

Practical example:

  • A project manager wants to add a "Severity" dropdown property to bug issues, with options like "Low", "Medium", and "High".
  • A team lead wants to track the estimated time (number) required to resolve an issue.
  • A product owner wants to add a "Release Date" property of type date to plan deployments.

Properties

Name Meaning
Project ID The unique identifier of the project where the issue property will be created.
Issue Type ID The unique identifier of the issue type to which the property will be attached.
Name Machine-friendly name of the issue property; must be without spaces (used internally).
Display Name Human-friendly display name of the issue property shown in the UI.
Property Type The data type of the issue property. Options: Option (Dropdown), Number, Text, Date.
Additional Fields Optional extra settings for the property:
- Description Text description explaining the purpose of the property.
- Is Required Boolean indicating if this property must be filled when creating issues.
- Is Active Boolean indicating if the property is currently active and usable.
- Is Multi Boolean indicating if multiple values can be selected (only applicable for Option type).
- Default Value Default value for the property; for Option type, this should be in JSON format representing options.

Output

The output of the node is the JSON response from the Plane API after creating the issue property. This typically includes details about the newly created property such as its ID, name, display name, type, and any additional metadata set during creation.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API via an authenticated API key credential configured in n8n.
  • The node uses internal helper functions to make HTTP requests to the Plane API endpoints.
  • The user must provide valid Project ID and Issue Type ID parameters corresponding to existing entities in Plane.

Troubleshooting

  • Missing Required Parameters: Ensure that Project ID, Issue Type ID, Name, Display Name, and Property Type are provided and valid.
  • Invalid Property Name: The "Name" field must be machine-friendly without spaces; otherwise, the API may reject the request.
  • API Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Incorrect Default Value Format: For Option type properties, the default value must be a valid JSON string representing the option(s).
  • Inactive Property Issues: If the property is marked inactive, it might not appear or be usable in the Plane UI or API.

If the node throws errors related to HTTP requests, check network connectivity and API endpoint availability.

Links and References

Discussion