Plane icon

Plane

Consume Plane API

Overview

This node integrates with the Plane API to manage project-related resources such as projects, issues, comments, labels, cycles, modules, issue properties, members, states, links, and attachments. Specifically for the Link resource with the Add Link operation, it allows users to add an external URL link to a specific issue within a project.

Common scenarios where this node is beneficial include:

  • Automatically attaching relevant external references or documentation URLs to issues in a project management workflow.
  • Enriching issue tracking by linking related web resources, tickets from other systems, or knowledge base articles.
  • Streamlining collaboration by programmatically adding links during automated workflows triggered by events or conditions.

Practical example:

  • When a new bug report is created, automatically add a link to a related support article or a log file hosted externally.
  • During sprint planning, attach design documents or API references as links to feature requests.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue.
Issue ID The unique identifier of the issue to which the link will be added.
URL The external URL to be linked to the issue.
Additional Fields Optional extra fields:
• Title: A descriptive title for the URL.
• Metadata: JSON metadata associated with the link resource.

Output

The node outputs a JSON object representing the newly created link resource attached to the specified issue. This typically includes details such as the link's ID, URL, title (if provided), metadata, and any other information returned by the Plane API about the link.

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 depends on the planeApiRequest and planeApiRequestAllItems helper functions to communicate with the Plane REST endpoints.
  • Proper permissions are needed on the Plane API side to create links on issues within the specified project.

Troubleshooting

  • Missing or invalid Project ID or Issue ID: Ensure that the provided IDs correspond to existing entities in Plane. Invalid IDs will cause API errors.
  • Invalid URL format: The URL must be a valid web address; otherwise, the API may reject the request.
  • Insufficient permissions: The API key used must have rights to modify issues and add links.
  • API rate limits or network issues: Temporary failures can occur due to network problems or API throttling.
  • Error messages from Plane API: These will be surfaced as node execution errors. Review the error message for clues, such as "Not Found" (invalid IDs) or "Unauthorized" (authentication issues).

To resolve errors:

  • Double-check all input parameters.
  • Verify API credentials and permissions.
  • Consult Plane API documentation for error codes and meanings.

Links and References

Discussion