BookStack icon

BookStack

Consume BookStack API

Actions40

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 Tag resource with the Create operation, it enables creating new tags within the BookStack system.

The node supports two modes of operation:

  • Automatic mode: Users provide a natural language description of their request (e.g., "Create a new tag for project management"), and the node attempts to infer the appropriate resource and operation.
  • Manual mode: Users explicitly select the resource (Tag) and operation (Create), then provide required parameters.

Typical use cases include automating content organization by programmatically adding tags to categorize books or pages, integrating BookStack tagging into workflows, or bulk-creating tags based on external data sources.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation: either "Set Automatically" or "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.

For the Tag - Create operation specifically, no additional input properties are defined in the provided snippet beyond these general ones. This suggests that tag creation relies primarily on the automatic inference or manual selection of resource and operation, with any further details handled internally or via other parameters not shown here.

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 for the create tag request under the json property.

Example structure of one output item:

{
  "json": {
    // The created Tag resource data returned by BookStack API
  },
  "pairedItem": {
    "item": 0
  }
}

No binary data output is indicated.

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 perform operations.

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 when manually setting resource and operation can cause API errors.

  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; verify and update credentials.
    • Validation errors from the API may occur if required fields for tag creation are missing or malformed.
    • Network errors suggest connectivity issues with the BookStack server.

  • Resolutions:

    • Double-check API credentials and ensure they have sufficient permissions.
    • Use manual mode if automatic detection fails or behaves unexpectedly.
    • Review the BookStack API documentation for required fields when creating tags.

Links and References

Discussion