Plane icon

Plane

Consume Plane API

Overview

The node interacts with the Plane API to manage "links" associated with issues within projects. Specifically, for the Link resource and Get Link operation, it retrieves a single link by its ID from a specified issue in a project.

This node is useful in scenarios where you need to programmatically fetch details about a specific link attached to an issue, such as retrieving metadata or URL information for integration, reporting, or automation workflows.

Example use case:

  • Automatically fetching a link's details when an issue is updated to synchronize with external systems or trigger further actions based on the link content.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue.
Issue ID The unique identifier of the issue that the link belongs to.
Link ID The unique identifier of the link to retrieve.

Output

The output is a JSON object representing the retrieved link's data. This typically includes all properties returned by the Plane API for a link resource, such as the link's URL, metadata, creation date, and any other relevant fields defined by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Plane API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to the Plane API endpoints.
  • No additional external services are required beyond the Plane API itself.

Troubleshooting

  • Common issues:

    • Invalid or missing Project ID, Issue ID, or Link ID parameters will cause the API request to fail.
    • Network connectivity problems or incorrect API credentials can result in authentication errors.
    • If the specified link does not exist, the API will return a not found error.
  • Error messages:

    • Errors from the Plane API will be propagated, often indicating invalid IDs or permission issues.
    • If the node throws an error about missing binary data, it indicates misuse of operations expecting file uploads (not applicable here).
    • To resolve errors, verify that all IDs are correct and that the API key has sufficient permissions.

Links and References

Discussion