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 operation creates a new comment on a specific issue within a project in the Plane API system. It is useful for adding detailed notes, feedback, or updates related to an issue tracked in a project management workflow.
Typical use cases include:
- Automatically posting comments from external systems or integrations when certain events occur.
- Adding rich HTML-formatted comments to issues to provide context or instructions.
- Setting visibility of comments as internal or external to control who can see them.
For example, you might use this node to add a developer's note to a bug report issue after running automated tests, or to post customer feedback as a comment on a support ticket issue.
Properties
| Name | Meaning |
|---|---|
| Project ID | The unique identifier of the project where the issue exists. |
| Issue ID | The unique identifier of the issue to which the comment will be added. |
| Comment HTML | The content of the comment in HTML format, allowing rich text and formatting. |
| Additional Fields | Optional extra settings for the comment. Currently supports: - Access: Visibility setting for the comment, with options: "Internal" or "External". |
Output
The output JSON contains the response from the Plane API after creating the comment. This typically includes details about the newly created comment such as its ID, content, creation timestamp, author information, and visibility status.
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 uses HTTP requests to interact with the Plane API endpoints.
- Proper permissions are needed on the Plane API side to create comments on issues within projects.
Troubleshooting
- Missing or invalid Project ID or Issue ID: Ensure that both IDs are correctly provided and correspond to existing entities in Plane.
- Invalid HTML content: The comment content must be valid HTML; malformed HTML may cause API errors.
- Permission errors: If the API key lacks permission to add comments, the request will fail. Verify API credentials and user roles.
- Access field misuse: The "Access" field must be either "Internal" or "External". Providing other values may cause errors.
- API rate limits or connectivity issues: Network problems or hitting API rate limits can cause failures; check network and API usage policies.
Common error messages usually come directly from the Plane API and indicate issues like unauthorized access, not found resources, or validation errors on input fields.
Links and References
- Plane API Documentation (general reference for endpoints and data models)
- n8n documentation on HTTP Request Node for understanding how API calls are made
- HTML basics for formatting comment content: MDN HTML Guide