BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API, enabling users to manage content within a BookStack instance programmatically. Specifically, for the Chapter - Create operation, it allows creating new chapters inside a specified book. This is useful in scenarios where automated documentation or content management workflows are needed, such as:

Automatically generating chapters based on external data or user input.
Integrating BookStack content creation into larger automation pipelines.
Bulk creating chapters from CSV or other data sources.

For example, you could use this node to create a new chapter titled "API Integration" inside a book identified by its ID, streamlining your documentation process.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: - Set Automatically - Set Manually
Request Description	(Shown if "Set Automatically" is chosen) Describe what you want to do, e.g., "Create a new chapter about API usage". The system will parse this text to select resource and operation automatically.
Name	The name/title of the chapter to create. Required.
Book ID	The ID of the book to which the new chapter belongs. Required.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains:

json: The response from the BookStack API representing the created chapter resource. This typically includes fields like the chapter's ID, name, book association, timestamps, and other metadata returned by the API.

No binary data output is produced by this node.

Dependencies

Requires access to a BookStack instance with API enabled.
Needs an API authentication token credential configured in n8n to authorize requests.
The base URL and tokens must be set correctly in the node credentials for successful API communication.

Troubleshooting

Common Issues:
- Invalid or missing Book ID: The API will reject requests if the book_id is not provided or incorrect.
- Authentication errors: Ensure the API token credential is valid and has sufficient permissions.
- Network connectivity issues to the BookStack server.
Error Messages:
- Errors returned from the BookStack API will be included in the output if "Continue On Fail" is enabled.
- Typical HTTP errors include 401 Unauthorized (check credentials), 404 Not Found (invalid book ID), or 400 Bad Request (missing required fields).
Resolution Tips:
- Verify that the book_id corresponds to an existing book in your BookStack instance.
- Double-check API credentials and their permissions.
- Use the manual mode to explicitly specify parameters if automatic detection fails.