Plane icon

Plane

Consume Plane API

Overview

The node interacts with the Plane API to manage various project management resources. Specifically, for the Link resource and the Update Link operation, it updates an existing external link associated with a specific issue within a project. This is useful when you need to modify details of a URL linked to an issue, such as correcting the URL, updating its title, or changing metadata.

Common scenarios include:

  • Updating the URL of a reference link attached to a bug report or feature request.
  • Changing the descriptive title of a link to better reflect its content.
  • Modifying metadata related to the link for enhanced categorization or integration purposes.

Example: You have an issue tracking a bug and previously added a link to a documentation page. The documentation URL has changed, so you use this node to update the link's URL and optionally its title or metadata.

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 belongs.
Link ID The unique identifier of the link to be updated.
Update Fields A collection of fields to update on the link:
- Title: The new title of the URL.
- URL: The new URL of the external link.
- Metadata: JSON object containing metadata from the resource (custom data).

Output

The output is a JSON object representing the updated link resource returned by the Plane API after the update operation. It typically includes the updated properties of the link such as its ID, title, URL, metadata, and any other relevant attributes provided by the API.

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.
  • Proper permissions are needed on the Plane API side to update links within projects and issues.

Troubleshooting

  • Missing or incorrect IDs: Ensure that the Project ID, Issue ID, and Link ID are correct and correspond to existing entities in Plane. Incorrect IDs will cause API errors.
  • Insufficient permissions: The API key used must have permission to update links; otherwise, the request will fail with authorization errors.
  • Invalid update fields: The metadata field must be valid JSON. Malformed JSON can cause request failures.
  • Network or API errors: Temporary network issues or Plane API downtime may cause errors. Retrying later or checking API status is recommended.
  • Error messages: The node throws errors if the API call fails. Review the error message for clues, such as "Not Found" (invalid IDs) or "Unauthorized" (permission issues).

Links and References

Discussion