Outline icon

Outline

Interact with Outline knowledge base

Overview

This node interacts with the Outline knowledge base API to manage comments among other resources. Specifically, the "Delete Comment" operation allows users to delete a comment by its unique ID. This is useful in scenarios where outdated, irrelevant, or inappropriate comments need to be removed from documents within the knowledge base.

Practical examples include:

  • Automatically deleting comments flagged as spam.
  • Removing user comments after a document update invalidates them.
  • Cleaning up comments during content moderation workflows.

Properties

Name Meaning
Comment ID The unique identifier of the comment to delete

Output

The output JSON contains the response from the Outline API after attempting to delete the specified comment. Typically, this will confirm whether the deletion was successful or provide error details if it failed.

The structure is generally:

{
  "json": {
    // API response fields indicating success or failure
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node uses a POST request to the /comments.delete endpoint of the Outline API.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Comment ID will result in an error from the API.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems can prevent the API call from succeeding.
  • Error messages and resolutions:

    • "Comment not found": Verify that the Comment ID is correct and exists.
    • "Authentication failed": Check that the API key credential is correctly configured and valid.
    • Timeout or network errors: Ensure stable internet connection and that the Outline API service is reachable.

Links and References

Discussion