OutlineInstall

Overview

This node interacts with the Outline knowledge base API, allowing users to perform various operations on different resources such as comments, documents, collections, groups, and more. Specifically, for the Comment - Get operation, it retrieves detailed information about a single comment by its ID. This is useful when you want to fetch the content and metadata of a specific comment within a document in Outline.

Practical examples include:

• Fetching a comment's details to display or process it further in a workflow.
• Using the comment data to trigger notifications or updates elsewhere.
• Auditing or logging comment content for compliance or review.

Properties

Output

The output contains a JSON object representing the comment's details as returned by the Outline API. This typically includes fields such as the comment's ID, content, author, creation date, and any other metadata provided by the API.

The node does not output binary data for this operation.

Example output structure (simplified):

{
  "id": "comment-id",
  "documentId": "document-id",
  "data": "The content of the comment",
  "createdAt": "timestamp",
  "updatedAt": "timestamp",
  "createdBy": {
    "id": "user-id",
    "name": "User Name"
  }
}

Dependencies

• Requires an API key credential for authenticating with the Outline knowledge base API.
• The node uses HTTP POST requests to communicate with the Outline API endpoints.
• No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

• Common issues:

  • Invalid or missing Comment ID: Ensure the Comment ID provided exists and is correct.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network or API downtime: Check connectivity and Outline service status.

• Common error messages:

  • "error": "Comment not found": The specified Comment ID does not exist; verify the ID.
  • "error": "Unauthorized": Authentication failed; check API credentials.
  • Timeout or network errors: Retry or check network settings.

Links and References

• Outline API Documentation (general reference for API endpoints)
• n8n documentation on creating custom nodes