BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Page resource with the Get Many operation, it retrieves multiple page records from the BookStack system.

The node supports two modes of operation selection:

  • Automatic mode: You provide a natural language description of your request (e.g., "List all pages in book X"), and the node attempts to infer the correct resource and operation.
  • Manual mode: You explicitly select the resource ("Page") and operation ("Get Many").

This node is beneficial when you want to programmatically fetch lists of pages from BookStack, for example:

  • Retrieving all pages within a specific book or chapter.
  • Listing pages for documentation automation or synchronization tasks.
  • Integrating BookStack content into other workflows or systems.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation: either "Set Automatically" by describing your request or "Set Manually" by selecting resource and operation explicitly.
Request Description (Shown only if "Tool Description" is set to "Set Automatically") Describe what you want to do in natural language (e.g., "Create a new page about API documentation"). The system uses this to infer the resource and operation.

Note: For the Page - Get Many operation specifically, no additional input properties are required beyond these, as the node constructs the appropriate API call based on the selected mode.

Output

The node outputs an array of JSON objects representing the retrieved pages. Each item corresponds to a page resource returned by the BookStack API under the json property.

Typical fields in each page object include (based on BookStack API standard but not limited to):

  • Page ID
  • Name/title of the page
  • HTML content or summary
  • Associated book and chapter IDs
  • Metadata such as creation and update timestamps

No binary data output is produced by this operation.

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 communicate with the BookStack API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing ambiguous or unsupported natural language descriptions in automatic mode may lead to incorrect resource/operation detection.
    • Network connectivity problems to the BookStack server can cause request timeouts or errors.

  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; verify and update credentials.
    • "Resource not found" errors may occur if filtering parameters or IDs are incorrect or missing.
    • If the node returns empty results unexpectedly, check that the BookStack instance contains pages matching the query criteria.

  • Resolution tips:

    • Use manual mode to explicitly specify resource and operation if automatic detection fails.
    • Validate API credentials and ensure the BookStack API endpoint is reachable.
    • Review the request description for clarity and specificity when using automatic mode.

Links and References

Discussion