BookStackInstall

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, 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 of operation:

• Automatic mode: Users provide a natural language description of their request, and the node attempts to parse and determine the appropriate resource and operation automatically.
• Manual mode: Users explicitly specify the resource ("Page") and operation ("Create") along with required properties.

This node is beneficial in scenarios where you want to programmatically add documentation or content pages to your BookStack instance, either by describing what you want in plain text or by specifying exact details. For example, you could automate creating a new page about "API Documentation" inside a particular book, helping maintain up-to-date knowledge bases or manuals.

Properties

Output

The node outputs JSON data representing the response from the BookStack API after creating the page. This typically includes details of the newly created page such as its ID, name, HTML content, associated book and chapter IDs, creation timestamps, and other metadata returned by the API.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
• The API requests are made to the /pages endpoint using HTTP POST method for creation.

Troubleshooting

• Missing Required Fields: If the "Name" or "Book ID" fields are not provided when manually creating a page, the API call will fail. Ensure these are set.
• Invalid Book or Chapter ID: Providing incorrect or non-existent IDs will cause errors from the API. Verify IDs before use.
• Authentication Errors: If the API key or token is invalid or missing, the node will return authorization errors. Check credential configuration.
• Automatic Mode Parsing Issues: When using automatic mode, ambiguous or unclear descriptions may lead to incorrect resource/operation detection. Try to be explicit or switch to manual mode.
• HTTP Errors: Network issues or incorrect base URLs can cause request failures. Confirm connectivity and correct API endpoint configuration.

Links and References

• BookStack Official API Documentation
• BookStack GitHub Repository
• n8n Documentation on Creating Custom Nodes