Confluence Cloud icon

Confluence Cloud

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

Actions43

Overview

This node operation retrieves a specific inline comment from Confluence Cloud by its unique comment ID. Inline comments are annotations or remarks attached directly to specific parts of page or blog post content, often used for detailed feedback or discussions within the context of the content.

Typical use cases include:

  • Fetching details of a particular inline comment for review or processing.
  • Integrating with workflows that require displaying or analyzing user comments on Confluence pages or blog posts.
  • Automating moderation or archival processes based on comment content or metadata.

For example, you might use this operation to get the full details of an inline comment to display it in a custom dashboard or to trigger notifications when certain comments are retrieved.

Properties

Name Meaning
Comment Id The unique numeric identifier of the inline comment to retrieve. This is required to specify which comment to fetch.
Additional Fields A collection of optional parameters to customize the response:
- Body Format Specifies the format type of the comment's body content to be returned (e.g., storage, view). If available, the formatted representation will be included under the body field.
- Version Retrieve a previously published version of the comment by specifying its version number.
- Include Properties Whether to include content properties associated with this inline comment in the response. Results are limited to 50 and sorted by default. Metadata and links indicate if more results exist.
- Include Operations Whether to include operations associated with this inline comment as defined in the Operation object. Limited to 50 results with pagination info.
- Include Likes Whether to include likes associated with this inline comment. Limited to 50 results with pagination info.
- Include Versions Whether to include versions associated with this inline comment. Limited to 50 results with pagination info.
- Include Version Whether to include the current version associated with this inline comment. Defaults to true; can be set to false to omit.

Output

The output JSON contains the detailed data of the requested inline comment, including but not limited to:

  • The comment's unique ID and metadata.
  • The body content of the comment in the specified format(s).
  • Associated properties, operations, likes, and versions if requested.
  • Pagination metadata (meta) and links (_links) if multiple related items are included.

This allows downstream nodes or workflows to access comprehensive information about the inline comment, including its content, history, and interactions.

No binary data output is indicated for this operation.

Dependencies

  • Requires an authenticated connection to Confluence Cloud via an API key or token credential configured in n8n.
  • The base URL for API requests is derived from the user's Confluence domain credential.
  • Permissions: The user must have permission to view the content of the page or blog post and its corresponding space where the inline comment exists.

Troubleshooting

  • Common Issues:

    • Invalid or missing Comment Id: Ensure the comment ID provided is correct and exists.
    • Permission errors: The API call requires appropriate permissions to view the comment and its parent content.
    • Network or authentication failures: Verify API credentials and network connectivity.

  • Error Messages:

    • 404 Not Found: The comment ID does not exist or is inaccessible due to permissions.
    • 401 Unauthorized: Authentication failed; check API credentials.
    • 400 Bad Request: Invalid parameters, such as unsupported body format or version number.

  • Resolutions:

    • Double-check the comment ID and ensure it is valid.
    • Confirm that the API credentials have sufficient permissions.
    • Validate optional parameters for correctness and supported values.

Links and References

Discussion