Plane icon

Plane

Consume Plane API

Overview

This node operation updates an existing issue within a specified project in the Plane API system. It allows users to modify various attributes of an issue such as its name, description, state, priority, assignees, labels, cycle, and module association.

Typical use cases include:

  • Changing the status or priority of a task or bug report.
  • Reassigning issues to different team members.
  • Updating descriptive details or categorization labels.
  • Associating the issue with different cycles or modules for better project organization.

For example, a project manager might update an issue's priority to "urgent" and assign it to a developer when a critical bug is discovered.

Properties

Name Meaning
Project Name or ID The identifier of the project containing the issue. Can be selected from a list or provided via expression.
Issue Name or ID The identifier of the issue to update. Must be provided; can be selected from a list or specified via expression.
Update Fields A collection of fields to update on the issue. These include:
- Name New name or title of the issue.
- Description HTML Updated HTML content describing the issue.
- State Name or ID The new state of the issue (e.g., backlog, in progress). Selectable from available states or specified by ID.
- Priority Priority level of the issue. Options are: High, Low, Medium, None, Urgent.
- Assignee Names or IDs List of users to assign the issue to. Selectable from project members or specified by IDs.
- Label Names or IDs Labels to associate with the issue for categorization. Selectable from existing labels or specified by IDs.
- Cycle Name or ID The cycle to associate the issue with, useful for sprint or milestone grouping. Selectable or specified by ID.
- Module Name or ID The module within the project to associate the issue with. Selectable or specified by ID.

Output

The output JSON contains the updated issue object returned from the Plane API after the PATCH request. This includes all current properties of the issue reflecting the applied updates.

The structure typically includes:

  • id: Unique identifier of the issue.
  • name: Updated issue name.
  • description_html: Updated HTML description.
  • state: Current state object or ID.
  • priority: Priority level.
  • assignees: Array of assigned user IDs.
  • labels: Array of label IDs.
  • cycle: Associated cycle ID.
  • module: Associated module ID.
  • Other metadata related to the issue.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API with appropriate authentication credentials (an API key or token).
  • The node depends on n8n's credential configuration for the Plane API.
  • Uses internal helper functions to make HTTP requests to Plane API endpoints.
  • Dynamic loading of options for projects, issues, states, members, labels, cycles, and modules is supported via API calls.

Troubleshooting

  • Missing Required Parameters: Ensure that both the project ID and issue ID are provided; otherwise, the update cannot proceed.
  • Invalid Field Values: When specifying states, priorities, assignees, labels, cycles, or modules, ensure the values exist in the project context. Use the dropdown lists or valid IDs.
  • API Errors: If the Plane API returns errors (e.g., permission denied, not found), verify API credentials and resource existence.
  • Empty Update Fields: If no fields are specified to update, the request may do nothing or fail. Always provide at least one field to update.
  • Network Issues: Connectivity problems with the Plane API endpoint will cause failures; check network and API availability.

Links and References

Discussion