Actions40
- Role Actions
- Page Actions
- Chapter Actions
- Book Actions
- Shelf Actions
- User Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Page - Create operation, it allows users to create a new page within a specified book (and optionally within a chapter) by providing details like the page name and HTML content.
Common scenarios where this node is beneficial include:
- Automating documentation workflows by programmatically adding new pages to a knowledge base.
- Creating structured content in BookStack based on external triggers or data sources.
- Integrating BookStack content creation into broader automation pipelines.
For example, you could use this node to automatically generate a new page titled "API Documentation" inside a specific book whenever a new API version is released.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | When using automatic mode, describe what you want to do (e.g., "Create a new page about API documentation"). The system will parse this to select resource and operation automatically. |
| Name | The name/title of the page to create. Required when creating or updating a page manually or automatically. |
| HTML Content | The HTML content/body of the page. Optional but recommended to provide meaningful content. |
| Book ID | The ID of the book to which the new page belongs. Required when creating a page. |
| Chapter ID | The ID of the chapter to which the page belongs (optional). |
Output
The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the full response from the BookStack API for the created page, including all metadata returned by the API such as the page ID, name, HTML content, associated book and chapter IDs, timestamps, and other relevant fields.
If an error occurs during processing and the node is set to continue on failure, the output for that item will contain an error field with the error message.
No binary data is output by this node.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API authentication token credential configured in n8n with:
- Base URL of the BookStack API.
- Token and token secret for authorization.
- The node uses HTTP requests authenticated with these credentials to perform operations.
Troubleshooting
- Missing or invalid Book ID: When creating a page, the
book_idmust be provided and valid. Failure to do so will result in API errors. - Invalid HTML content: Providing malformed HTML might cause unexpected rendering or API rejection.
- Authentication errors: Ensure the API token and base URL are correctly configured; otherwise, requests will fail with authorization errors.
- Automatic detection failures: If using automatic mode with a vague or ambiguous request description, the node might select incorrect resource or operation. In such cases, switch to manual mode for precise control.
- ID parsing issues: When specifying IDs in automatic mode via the request description, ensure the format matches expected patterns (e.g., "ID: 123").
Links and References
- BookStack Official API Documentation
- BookStack GitHub Repository
- n8n Documentation on HTTP Request Node (for understanding underlying HTTP calls)
This summary focuses on the Page resource's Create operation, describing how to configure inputs, what outputs to expect, and common considerations when using the node.