BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to export content from a specified resource—specifically a Book, Page, or Chapter—in various formats. It is useful for users who want to programmatically retrieve and save documentation or knowledge base content in different file types for offline use, sharing, or further processing.

Typical scenarios include:

  • Exporting a page as a PDF to distribute as a report.
  • Exporting an entire book in Markdown format for version control or editing.
  • Exporting chapters as HTML for embedding in other web applications.

Properties

Name Meaning
Export Format The format to export the resource in. Options: HTML, PDF, Markdown, Plain Text

Output

The node outputs the exported content of the selected resource in the chosen format. The json output field will contain the raw data returned by the BookStack API export endpoint, which typically includes the content of the resource formatted accordingly.

If the export format is binary (e.g., PDF), the node will provide the data as binary output suitable for saving as a file or further processing.

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n with access rights to read/export the specified resources.
  • The base URL of the BookStack API must be set in the credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect resource ID or non-existent resource will result in "resource not found" errors.
    • Unsupported export format or API changes might cause unexpected errors.
  • Error messages:

    • 401 Unauthorized: Check that the API token is valid and has sufficient permissions.
    • 404 Not Found: Verify the resource ID exists and matches the resource type.
    • 400 Bad Request: Ensure the export format is one of the supported options (HTML, PDF, Markdown, Plain Text).

Links and References

Discussion