Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage issues within project modules. Specifically, for the Module Issue resource and the Get Issues operation, it retrieves all issues associated with a specified module inside a given project.

Common scenarios where this node is beneficial include:

  • Fetching all issues related to a particular module in a project for reporting or analysis.
  • Integrating issue data from Plane into other workflows or dashboards.
  • Automating monitoring or synchronization of module-specific issues.

Practical example:

  • A project manager wants to pull all issues from the "Frontend" module of a project to review progress or export them to another system. By providing the project ID and module ID, this node fetches all relevant issues efficiently.

Properties

Name Meaning
Project ID The unique identifier of the project containing the module. This is required to scope the request.
Module ID The unique identifier of the module whose issues are to be retrieved. This is required to specify the module.

Output

The output is an array of JSON objects representing the issues belonging to the specified module. Each issue object typically contains details such as issue ID, name, description, status, priority, assignees, labels, and other metadata as provided by the Plane API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active Plane API credential configured in n8n to authenticate requests.
  • Depends on the Plane API service being accessible and responsive.
  • Uses internal helper functions to paginate through all items if there are multiple pages of issues.

Troubleshooting

  • Common issues:

    • Invalid or missing Project ID or Module ID parameters will cause the API call to fail.
    • Network connectivity problems or Plane API downtime can result in request failures.
    • Insufficient permissions on the Plane API key may prevent access to project or module data.
  • Error messages:

    • Errors returned from the Plane API will be propagated, often indicating invalid IDs or authorization errors.
    • If no issues are found, the output will simply be an empty array without error.
    • If the node fails due to missing binary data (not applicable here), it would throw a specific error, but this operation does not handle binary data.

To resolve errors:

  • Verify that the Project ID and Module ID are correct and exist in Plane.
  • Ensure the API key has sufficient permissions.
  • Check network connectivity and Plane API status.

Links and References


This summary focuses solely on the Module Issue resource and the Get Issues operation as requested.

Discussion