BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API to manage content resources such as pages, books, chapters, and shelves. Specifically, for the Page - Create operation, it allows users to create a new page within a specified book (and optionally within a chapter). The node supports two modes:

  • Automatic mode: Users provide a natural language description of what they want to do (e.g., "Create a new page about API documentation"), and the node attempts to parse this description to determine the resource, operation, and relevant data fields automatically.
  • Manual mode: Users explicitly specify the resource ("Page"), operation ("Create"), and all required properties.

Typical use cases include automating documentation workflows, programmatically adding new content pages to a knowledge base, or integrating BookStack content creation into larger automation pipelines.

Example: Automatically creating a page titled "API Documentation" inside a specific book by describing the request in plain text, or manually specifying the page name, HTML content, and associated book ID.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if "Set Automatically") Describe your request in natural language; the system parses this to select resource and operation automatically. Example: "Create a new page about API documentation".
Name The name/title of the page to create. Required when creating or updating a page (manual or automatic).
HTML Content The HTML content/body of the page. Optional but recommended to define the page's content.
Book ID The ID of the book to which this page belongs. Required when creating a page.
Chapter ID The ID of the chapter this page belongs to (optional). Useful for organizing pages within chapters.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains the full JSON response from the BookStack API representing the created page resource, including its ID, name, HTML content, and metadata.

If an error occurs during processing and "Continue On Fail" is enabled, the output will contain an error field with the error message for that item.

No binary data output is produced by this node.

Dependencies

  • Requires access to the BookStack API.
  • Requires an API authentication token credential configured in n8n with:
    • Base URL of the BookStack instance.
    • API token and secret for authorization.
  • The node uses HTTP requests with JSON payloads to communicate with the BookStack REST API.

Troubleshooting

  • Missing Required Fields: Creating a page requires at least the name and book_id. Omitting these will cause API errors.
  • Invalid Book or Chapter IDs: Providing non-existent or invalid IDs will result in API errors indicating resource not found.
  • Authentication Errors: Ensure the API token and base URL are correctly configured; otherwise, the node will fail with authorization errors.
  • Parsing Failures in Automatic Mode: If the natural language description is ambiguous or does not clearly specify the resource or operation, the node may default to incorrect assumptions or fail. In such cases, switch to manual mode or clarify the description.
  • HTTP Errors: Network issues or API downtime can cause request failures. Check connectivity and API status.

Links and References

Discussion