Confluence Cloud icon

Confluence Cloud

Access to the Confluence Cloud REST API - Auto-generated from OpenAPI

Overview

The "Create Inline Comment" operation in the Confluence Cloud node allows users to create inline comments on Confluence pages or blog posts. Inline comments are tied to specific text selections within the content, enabling contextual discussions and feedback directly related to highlighted text. This is particularly useful for collaborative editing, peer reviews, or detailed feedback on documentation.

Typical use cases include:

  • Adding a comment on a specific paragraph or sentence in a Confluence page.
  • Replying to an existing inline comment to continue a discussion thread.
  • Highlighting text and attaching notes or questions for team members.

For example, a user can automate adding inline comments to a page after running a content analysis workflow, or integrate with external review tools to post comments programmatically.

Properties

Name Meaning
Request Body The JSON-formatted request body containing data for the inline comment creation. This includes fields such as pageId or blogPostId to specify the target content, parentCommentId if replying to an existing comment, and inlineCommentProperties which define the text selection to highlight.

Output

The output of this operation is the JSON response from the Confluence Cloud API representing the newly created inline comment. This typically includes details such as the comment ID, body content, author information, creation timestamp, and metadata about the inline text selection.

No binary data is involved in this operation.

Dependencies

  • Requires access to a Confluence Cloud instance via its REST API.
  • An API authentication token (API key credential) must be configured in n8n to authorize requests.
  • The base URL for the Confluence Cloud API is derived from the user's credentials configuration.

Troubleshooting

  • Permission Errors: If the operation fails due to insufficient permissions, ensure that the API token has rights to view the target page/blog post and create comments in the corresponding space.
  • Invalid Request Body: The request body must be valid JSON and include required fields like pageId or blogPostId. Malformed JSON or missing required properties will cause errors.
  • Text Selection Issues: The inlineCommentProperties object must correctly specify the text range to highlight; otherwise, the comment may not attach properly.
  • API Rate Limits: Frequent automated calls might hit Confluence API rate limits; handle such errors by implementing retries or backoff strategies.

Links and References

Discussion