BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API 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: You provide a natural language description of what you want to do (e.g., "List all users"), and the node attempts to infer the correct resource and operation.
  • Manual mode: You explicitly select the resource and operation.

This node is beneficial when automating documentation workflows, managing user accounts, or integrating BookStack content into other systems. For example, you could use it to fetch all users to synchronize them with another platform or generate reports on user activity.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown only if Tool Description is "Set Automatically") Describe your request in natural language, e.g., "List all users"
Resource (Shown only if Tool Description is "Set Manually") Select the resource to operate on. Options include: Book, Page, Chapter, Shelf, User, Role, Attachment, Tag
Operation (Shown only if Tool Description is "Set Manually") Select the operation to perform. Options include: Create, Delete, Get, Get Many, Update

For the User - Get Many operation specifically, the relevant properties are:

  • Tool Description: Usually "Set Automatically" or "Set Manually"
  • Request Description: If automatic, a text describing the request
  • Resource: Must be set to "User" if manual
  • Operation: Must be set to "Get Many" (internally called "getAll")

Output

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

Example structure of each user object (based on typical BookStack API responses, not explicitly shown in code):

{
  "id": 123,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "Editor",
  ...
}

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The base URL and tokens must be configured in the node credentials.
  • The node uses HTTP requests with authentication to communicate with the BookStack REST 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.
    • Missing required parameters (like IDs for single resource operations) can cause errors.
    • Network connectivity issues to the BookStack server.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens.
    • HTTP 404 errors may occur if the requested resource or endpoint does not exist.
    • Validation errors if required fields are missing or malformed.

  • Resolutions:

    • Verify API credentials and permissions.
    • Use manual mode if automatic detection fails.
    • Ensure the BookStack server URL is correct and accessible.
    • Provide all required parameters for the selected operation.

Links and References

Discussion