OutlineInstall

Overview

This node interacts with the Outline knowledge base API, specifically to create a comment on a document within Outline. It allows users to add textual comments linked to a specific document, which can be useful for collaboration, feedback, or annotation purposes in knowledge management workflows.

Common scenarios include:

• Adding user feedback or notes to a document automatically after some processing.
• Creating discussion threads or comments programmatically as part of a content review process.
• Integrating Outline comments into broader automation workflows where comments trigger other actions.

Example: Automatically post a comment summarizing recent changes to a document whenever it is updated.

Properties

Output

The output JSON contains the response from the Outline API after creating the comment. This typically includes details about the newly created comment such as its ID, content, associated document ID, creation timestamp, and possibly author information.

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the Outline API.
• The node uses the Outline API endpoint /comments.create via a POST request.
• Proper configuration of the Outline API credentials in n8n is necessary.

Troubleshooting

• Common issues:

  • Missing or invalid API authentication token will cause authorization errors.
  • Providing an invalid or missing documentId parameter (not shown in properties but required internally) may result in failure to associate the comment with a document.
  • Empty or malformed comment content could lead to API validation errors.

• Error messages:

  • Authorization errors: Check that the API key credential is correctly set up and has sufficient permissions.
  • Validation errors: Ensure the comment content is not empty and the target document exists.
  • Network or timeout errors: Verify network connectivity and API availability.

Links and References

• Outline API Documentation - Comments
• Outline Knowledge Base