Outline icon

Outline

Interact with Outline knowledge base

Overview

This node interacts with the Outline knowledge base service, specifically allowing you to update an existing comment. It is useful when you want to modify the content of a comment previously added to a document in Outline. For example, if a user needs to correct or add information to a comment on a document, this node can be used to update that comment's text.

Properties

Name Meaning
Comment ID The unique identifier of the comment you want to update.
Comment Data The new content/text of the comment to replace the existing one.

Output

The output contains a JSON object representing the updated comment as returned by the Outline API. This typically includes the updated comment details such as its ID, updated content, timestamps, and possibly metadata related to the comment.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node uses the Outline API endpoints internally to perform the update operation.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Comment ID will result in an error from the API indicating the comment could not be found.
    • Missing or empty "Comment Data" will likely cause the update to fail or have no effect.
    • Authentication errors if the API key is missing, expired, or incorrect.
  • Error messages and resolutions:

    • "Comment not found": Verify the Comment ID is correct and exists in the target Outline document.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly configured and valid.
    • "Invalid input": Ensure that the Comment Data is properly formatted and not empty.

Links and References

Discussion