Confluence Cloud icon

Confluence Cloud

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

Actions43

Overview

This node operation retrieves a specific footer comment from Confluence Cloud by its unique comment ID. Footer comments are comments located at the bottom (footer) of pages, blog posts, or other content types in Confluence. This operation is useful when you need to fetch detailed information about a particular footer comment, including its content, metadata, and optionally related properties such as versions, likes, and operations.

Common scenarios:

  • Fetching a specific comment to display or process it in an automation workflow.
  • Retrieving historical versions or details of a comment for auditing or review.
  • Including additional metadata like likes or operations associated with the comment for richer context.

Practical example:

  • An automation that monitors comments on a page and triggers notifications or actions based on the content or status of a specific footer comment identified by its ID.

Properties

Name Meaning
Comment Id The unique numeric ID of the footer 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 The format type of the comment body to be returned (e.g., storage, view). If specified, the response will include the body content in this format.
- Version Retrieve a previously published version of the comment by specifying its version number.
- Include Properties Whether to include content properties associated with the footer comment. Limited to 50 results with pagination info.
- Include Operations Whether to include operations associated with the footer comment, describing permissions or actions available. Limited to 50 results with pagination info.
- Include Likes Whether to include likes associated with the footer comment. Limited to 50 results with pagination info.
- Include Versions Whether to include all versions associated with the footer comment. Limited to 50 results with pagination info.
- Include Version Whether to include the current version of the footer comment. Defaults to true; can be set to false to omit.

Output

The output JSON contains the detailed data of the requested footer comment. This includes fields such as:

  • The comment's unique ID and content.
  • The body of the comment in the requested format.
  • Metadata about the comment, such as creation date, author, and status.
  • Optionally included arrays or objects for properties, operations, likes, versions, and the current version depending on the input options.

No binary data is involved in this operation.

Dependencies

  • Requires access to a Confluence Cloud instance via its REST API.
  • Requires an API authentication credential configured in n8n to authorize requests.
  • The base URL for API requests is dynamically set from the user's credentials (the Confluence domain).

Troubleshooting

  • Invalid Comment Id: If the provided comment ID does not exist or the user lacks permission to view it, the API will return an error. Verify the comment ID and ensure appropriate permissions.
  • Permission Errors: Insufficient permissions to view the content or comment will result in authorization errors. Ensure the API key has the necessary scopes and the user has access rights.
  • Version Not Found: Specifying a non-existent version number will cause an error. Confirm the version number is valid.
  • API Rate Limits: Excessive requests may trigger rate limiting. Implement retries or backoff strategies if needed.
  • Malformed Additional Fields: Incorrectly formatted additional fields (e.g., invalid body format string) may cause request failures. Validate inputs carefully.

Links and References

Discussion