Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

The node provides integration with the Outline knowledge base platform, allowing users to perform various operations on different resources such as documents, collections, comments, groups, and more. Specifically for the Document - Unpublish operation, this node allows you to unpublish a document by its ID, effectively removing it from public or shared visibility while keeping it in the system.

This operation is useful when you want to retract or hide a document that was previously published without deleting it entirely. For example, if a document contains outdated information or needs revision before being visible again, unpublishing it can temporarily remove access.

Practical scenarios include:

  • Managing internal documentation lifecycle by unpublishing obsolete articles.
  • Temporarily hiding sensitive content during updates.
  • Controlling document visibility programmatically within automated workflows.

Properties

Name Meaning
Document ID The unique identifier of the document to unpublish. This is required to specify which document to act upon.

Output

The output of the node after executing the unpublish operation is a JSON object representing the response from the Outline API. Typically, this will contain details about the document's updated state after unpublishing.

The exact structure depends on the Outline API response but generally includes fields confirming the document has been unpublished.

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 HTTP POST requests to communicate with the Outline API endpoints.
  • Proper configuration of the Outline API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing Document ID: Ensure the Document 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.

  • Error messages:

    • Errors returned from the Outline API will be passed through. For example, "Document not found" indicates an invalid Document ID.
    • Authentication failures typically indicate invalid or expired credentials.

  • Resolution tips:

    • Double-check input parameters, especially the Document ID.
    • Reconfigure or update the API authentication token.
    • Review Outline API documentation for permission requirements.

Links and References

Discussion