Outline icon

Outline

Interact with Outline knowledge base

Overview

This node integrates with the Outline knowledge base platform, allowing users to perform various operations on different resources such as collections, documents, comments, groups, and more. Specifically, for the Collection - Export operation, it enables exporting a specified collection from the Outline knowledge base.

Typical use cases include:

  • Backing up or migrating a collection of documents.
  • Exporting content for offline access or further processing.
  • Integrating Outline data export into automated workflows.

For example, you might use this node to export a collection by its ID and then save the exported data to cloud storage or send it via email.

Properties

Name Meaning
Collection ID The unique identifier of the collection to export. This is required to specify which collection to export.

Output

The output of the export operation is a JSON object representing the exported collection data as returned by the Outline API. This typically includes all relevant information about the collection's contents in a structured format suitable for backup or import elsewhere.

The node does not output binary data for this operation; all data is provided in JSON format.

Dependencies

  • Requires an API key credential for authenticating with the Outline API.
  • The node makes HTTP POST requests to Outline API endpoints to perform actions.
  • No additional external dependencies are needed beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Collection ID: Ensure the Collection ID is correctly provided and exists in your Outline instance.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or API downtime: Check connectivity and Outline service status if requests fail.
  • Error messages:

    • Errors returned from the Outline API will be passed through. For example, "Collection not found" indicates an invalid ID.
    • If the node is set to continue on failure, error details will appear in the output JSON under an error field.

Links and References

Discussion