Plane icon

Plane

Consume Plane API

Overview

This node interacts with the "Cycle" resource of the Plane API, specifically supporting the Create operation. It allows users to create a new cycle within a specified project by providing essential details such as the cycle's name and optional additional fields like description, start date, end date, and owner.

Typical use cases include:

  • Organizing work into time-bound cycles or sprints within a project management workflow.
  • Automating the creation of development or release cycles based on external triggers or schedules.
  • Integrating cycle creation into broader automation workflows that manage project timelines.

For example, you might use this node to automatically create a new sprint cycle at the beginning of each month, specifying its start and end dates and assigning an owner.

Properties

Name Meaning
Project ID The unique identifier of the project in which the cycle will be created (required).
Name The name of the cycle to be created (required).
Additional Fields Optional extra details for the cycle:
- Description A textual description of the cycle.
- Start Date The start date/time of the cycle.
- End Date The end date/time of the cycle.
- Owned By The user ID of the person who owns or is responsible for this cycle.

Output

The output JSON contains the newly created cycle object returned from the Plane API. This typically includes all properties of the cycle such as its ID, name, description, start and end dates, owner information, and any other metadata provided or generated by the API.

No binary data output is produced by 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.
  • The projectId must correspond to an existing project accessible by the API key.

Troubleshooting

  • Missing or invalid Project ID: Ensure the Project ID is correct and that the API key has permission to access the project.
  • Required fields not set: The Name and Project ID fields are mandatory; missing these will cause errors.
  • API authentication errors: Verify that the API key credential is valid and properly configured in n8n.
  • Date format issues: The Start Date and End Date should be valid ISO 8601 datetime strings; invalid formats may cause request failures.
  • Permission errors: The user associated with the API key must have rights to create cycles in the specified project.

Common error messages will generally come from the Plane API and indicate issues such as unauthorized access, validation errors on input fields, or resource not found.

Links and References

Discussion