BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API, enabling users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Chapter resource with the Move operation, the node allows relocating a chapter from one book or shelf to another within BookStack.

Common scenarios where this node is beneficial include reorganizing documentation structures by moving chapters between books or collections, maintaining up-to-date content hierarchies, or automating content management workflows in BookStack.

For example, you might use this node to move a chapter titled "Introduction" from one book to another after restructuring your documentation, ensuring that all related content stays organized without manual intervention.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown only if "Set Automatically" is selected) Describe your request in natural language; the system will attempt to automatically select the appropriate resource and operation based on this description. Example: "Move the chapter 'Getting Started' to the book 'User Guide'".

Note: For the Move operation on the Chapter resource, when set manually, additional parameters like the chapter ID and target location are expected but not explicitly listed in the provided properties snippet. The node internally handles setting the target book or shelf IDs during the move operation.

Output

The node outputs JSON data representing the response from the BookStack API after performing the move operation. This typically includes details of the moved chapter resource, such as its new location and metadata.

If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is produced by this node.

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Requires an API authentication token credential configured in n8n with:
    • Base URL of the BookStack API.
    • Authorization token and secret.
  • The node uses HTTP requests authenticated with these credentials to perform operations.

Troubleshooting

  • Common Issues:

    • Incorrect or missing chapter ID: The move operation requires a valid chapter ID to identify which chapter to move.
    • Invalid target book or shelf ID: The target location must exist and be accessible with the provided credentials.
    • Insufficient permissions: The API token must have rights to modify chapters and their locations.
    • Network or connectivity issues with the BookStack API endpoint.

  • Error Messages:

    • Errors returned from the BookStack API will be included in the output JSON under an error key.
    • Authentication errors indicate invalid or expired API tokens.
    • Validation errors may occur if required parameters are missing or invalid.

  • Resolution Tips:

    • Verify that the chapter ID and target location IDs are correct.
    • Ensure the API token has sufficient permissions.
    • Check network connectivity and API endpoint correctness.
    • Use the "Set Manually" mode if automatic detection does not correctly interpret the request.

Links and References

Discussion