BookStack

Overview

This node integrates with the BookStack API, allowing users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the User resource with the Get Many operation, it retrieves a list of users from the BookStack system.

The node supports two modes for specifying the request:

• Automatic mode: The user provides a natural language description of what they want to do (e.g., "List all users"), and the node attempts to parse this description to determine the resource and operation automatically.
• Manual mode: The user explicitly selects the resource ("User") and operation ("Get Many") from dropdowns.

This node is beneficial in scenarios where you want to automate or integrate BookStack user management into workflows, such as syncing users, auditing user lists, or triggering actions based on user data.

Practical example

• Automatically retrieve all users by describing your request as "List all users" in automatic mode.
• Manually select the User resource and Get Many operation to fetch all users for further processing or reporting.

Properties

Output

The output is an array of JSON objects representing the users retrieved from the BookStack API. Each item corresponds to one user resource as returned by the API under the data property.

The structure of each user object depends on the BookStack API's user schema but typically includes fields like user ID, name, email, roles, and other user metadata.

No binary data output is produced by this node.

Dependencies

• Requires connection to a BookStack instance via its API.
• Needs an API token credential configured in n8n with:
  • Base URL of the BookStack API.
  • Authentication token and secret.
• The node uses HTTP requests authenticated with these credentials to interact 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 selection or errors.
  • If the BookStack API base URL is misconfigured (missing /api suffix or trailing slashes), requests may fail.

• Error messages:

  • Authentication errors usually indicate invalid or expired tokens; verify and update credentials.
  • HTTP 404 or 400 errors may indicate incorrect resource paths or parameters; check the resource and operation selections.
  • Parsing errors in automatic mode can be mitigated by simplifying or clarifying the request description.

Links and References

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