BookStack icon

BookStack

Consume BookStack API

Actions40

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 Role - Create operation, it allows users to create a new role within the BookStack system.

The node supports two modes of operation:

  • Automatic mode: The user provides a natural language description of the desired action (e.g., "Create a new role for editors"), and the node attempts to parse this description to determine the resource and operation automatically.
  • Manual mode: The user explicitly selects the resource ("Role") and operation ("Create") and provides the necessary input properties.

Typical use cases include automating the creation of roles in BookStack for managing permissions or organizing users, either by specifying details directly or describing the request in plain language.

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) A text description of what you want to do; the system uses this to infer the resource and operation automatically. Example: "Create a new role for editors".

For the Role - Create operation specifically, no additional input properties are defined in the provided snippet beyond these general ones. This suggests that the node may rely on the automatic parsing of the description or minimal manual input for creating roles.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the BookStack API after performing the requested operation.

For the Create Role operation, the JSON output will typically include the details of the newly created role as returned by the BookStack API, such as its ID, name, permissions, and other metadata.

No binary data output is indicated for 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 with JSON payloads to communicate with the BookStack API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid or incomplete request description in automatic mode may lead to incorrect resource/operation detection or errors.
    • Missing required fields when manually setting parameters can cause API errors.

  • Error messages:

    • Authentication errors usually indicate invalid or expired tokens; verify and update credentials.
    • Validation errors from the API may occur if required fields for creating a role are missing or malformed.
    • Network or connectivity errors suggest issues reaching the BookStack server; check the base URL and network access.

  • Resolution tips:

    • Ensure API credentials are correctly set up in n8n.
    • When using automatic mode, provide clear and concise descriptions.
    • Use manual mode to explicitly specify resource and operation if automatic detection fails.
    • Check the BookStack API documentation for required fields when creating roles.

Links and References

Discussion