Actions63
- Comment Actions
- Cycle Actions
- Cycle Issue Actions
- Issue Actions
- Issue Attachment Actions
- Issue Property Actions
- Issue Property Option Actions
- Issue Property Value Actions
- Issue State Actions
- Label Actions
- Link Actions
- Member Actions
- Module Actions
- Module Issue Actions
- Project Actions
Overview
This node interacts with the Plane API to manage comments on issues within projects. Specifically, the Update Comment operation allows users to modify an existing comment associated with a particular issue in a project. This is useful for scenarios where you need to correct, enhance, or change the visibility of comments after they have been created.
Practical examples include:
- Updating a comment's content to add new information or fix typos.
- Changing the visibility of a comment from internal-only to external-facing or vice versa.
- Automating comment updates based on external triggers or workflows.
Properties
| Name | Meaning |
|---|---|
| Project ID | The unique identifier of the project containing the issue and comment to update. |
| Issue ID | The unique identifier of the issue to which the comment belongs. |
| Comment ID | The unique identifier of the comment that you want to update. |
| Update Fields | A collection of fields to update in the comment: |
| Comment HTML | The updated HTML content of the comment. |
| Access | The visibility setting of the comment. Options: "Internal" or "External". |
Output
The output JSON contains the updated comment object as returned by the Plane API after the PATCH request. This typically includes the comment's ID, updated content, visibility status, timestamps, and any other metadata provided by the API.
No binary data output is involved in this operation.
Dependencies
- Requires access to the Plane API via an authenticated API key credential configured in n8n.
- The node depends on the
planeApiRequesthelper function to make HTTP requests to the Plane API endpoints. - Proper permissions are needed to update comments within the specified project and issue.
Troubleshooting
Common Issues:
- Invalid or missing Project ID, Issue ID, or Comment ID will cause the API call to fail.
- Insufficient permissions or invalid API credentials can result in authorization errors.
- Providing invalid HTML content or unsupported values for the access field may cause validation errors.
Error Messages:
- Errors from the Plane API will be propagated, such as "Comment not found" if the Comment ID does not exist.
- Network or authentication errors will indicate issues with API connectivity or credentials.
Resolution Tips:
- Double-check all IDs (Project, Issue, Comment) for correctness.
- Ensure the API key credential is valid and has necessary scopes.
- Validate the HTML content before sending it.
- Use the "Internal" or "External" options exactly as specified for the access property.
Links and References
- Plane API Documentation (general reference for endpoints)
- n8n documentation on Creating Custom Nodes
- Plane API authentication and permission setup guides (refer to your Plane API provider resources)