BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to manage content within a BookStack instance. Specifically, the Page - Create operation allows users to create a new page inside a specified book (and optionally within a chapter). This is useful for automating documentation workflows, content publishing, or knowledge base management by programmatically adding pages with custom HTML content.

Practical examples:

  • Automatically generating and adding new documentation pages from external data sources.
  • Creating structured content pages in bulk for onboarding materials.
  • Integrating with other systems to update knowledge bases dynamically.

Properties

Name Meaning
Name The title of the page to be created.
HTML Content The HTML markup content that will make up the body of the page.
Book ID The identifier of the book under which this page will be created.
Chapter ID (Optional) The identifier of the chapter within the book where the page should belong.

Output

The node outputs JSON data representing the newly created page resource as returned by the BookStack API. This typically includes fields such as the page ID, name, HTML content, associated book and chapter IDs, creation timestamps, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n with:
    • Base URL of the BookStack server.
    • Token ID and secret for authorization.
  • The node uses HTTP POST requests to the /pages endpoint of the BookStack API.

Troubleshooting

  • Missing required fields: Ensure that "Name" and "Book ID" are provided; these are mandatory for creating a page.
  • Invalid Book or Chapter ID: If the provided IDs do not exist or are incorrect, the API will return an error. Verify IDs before running the node.
  • Authentication errors: Check that the API token credentials are correctly set up and have sufficient permissions.
  • HTML content issues: Malformed HTML might cause rendering problems in BookStack but usually won't block creation.
  • API connectivity: Network issues or incorrect base URL configuration can prevent successful API calls.

Links and References

Discussion