Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage comments related to issues within projects. Specifically, the "Comment" resource with the "Get Many" operation retrieves all comments associated with a particular issue in a project.

Common scenarios where this node is beneficial include:

  • Fetching all discussion or feedback entries on a specific issue for review or processing.
  • Aggregating comments for reporting or analysis purposes.
  • Synchronizing comments from Plane into other systems or workflows.

Practical example:

  • A user wants to gather all comments on a bug report issue in a project to send them as part of a status update email.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue. This is required to scope the request to the correct project.
Issue ID The unique identifier of the issue whose comments are to be retrieved. This is required to specify which issue's comments to fetch.

Output

The output is a JSON array where each element represents a comment object retrieved from the Plane API for the specified issue. Each comment typically includes fields such as the comment content (likely in HTML format), author information, timestamps, and any metadata provided by the Plane 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 Plane endpoints.
  • The user must provide valid Project ID and Issue ID parameters to successfully retrieve comments.

Troubleshooting

  • Common Issues:

    • Missing or invalid Project ID or Issue ID will cause the API request to fail.
    • Network connectivity problems or incorrect API credentials can result in authentication errors.
    • If the specified issue has no comments, the output will be an empty array.
  • Error Messages:

    • Errors returned from the Plane API will be propagated, such as "Not Found" if the project or issue does not exist.
    • If the node throws an error about missing binary data, it indicates a misconfiguration unrelated to this operation (since this operation does not handle binary data).
  • Resolutions:

    • Verify that the Project ID and Issue ID are correct and correspond to existing entities in Plane.
    • Ensure the API key credential is correctly set up and has sufficient permissions.
    • Check network connectivity and Plane API service status.

Links and References

Discussion