Plane icon

Plane

Consume Plane API

Overview

The node interacts with the Plane API to manage issue attachments within projects. Specifically, the "Complete Upload" operation finalizes the upload process of a file attachment (asset) to a specific issue in a project. This is useful when you have already uploaded the file data and need to confirm or complete the upload so that the attachment becomes available and linked to the issue.

Common scenarios include:

  • Uploading large files in multiple steps where the initial upload sends the file data, and this operation signals completion.
  • Finalizing an attachment upload after setting optional metadata like file name, size, or MIME type.
  • Automating issue tracking workflows by programmatically attaching files to issues.

Example use case:

  • After uploading a screenshot or log file as an attachment to a bug report issue, call this operation to complete the upload and make the attachment accessible in the issue tracker.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue.
Issue ID The unique identifier of the issue to which the attachment belongs.
Asset ID The unique identifier of the uploaded asset (file) for which the upload completion is requested.
Additional Fields Optional metadata about the file attachment:
- Name: The filename.
- Size: File size in bytes.
- Type: MIME type of the file.

Output

The output JSON contains the response from the Plane API confirming the completion of the upload for the specified asset attached to the issue. It typically includes details about the finalized attachment such as its ID, URL, metadata, and status.

No binary data is output by this operation; it only confirms the upload completion and returns metadata.

Dependencies

  • Requires access to the Plane API via an authenticated API key credential configured in n8n.
  • The node depends on the Plane API endpoints for projects, issues, and attachments.
  • No additional external services are required specifically for this operation.

Troubleshooting

  • Missing Binary Data: If attempting to upload before completing upload, ensure the binary property exists on the input item; otherwise, errors will occur.
  • Invalid Asset ID: Providing an incorrect or non-existent asset ID will cause the API request to fail. Verify the asset ID returned from the initial upload step.
  • API Authentication Errors: Ensure the API key credential is valid and has permissions to modify attachments in the target project.
  • Incomplete Metadata: While additional fields are optional, providing accurate file name, size, and MIME type helps avoid issues with file handling downstream.
  • Network or API Errors: Handle transient network failures by enabling "Continue On Fail" if appropriate, or retry the operation.

Links and References

Discussion