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 Get Many operation, it retrieves a list of tags from the BookStack system.

Common scenarios where this node is beneficial include:

  • Fetching all tags available in a BookStack instance to display or process them elsewhere.
  • Automating workflows that require tag data, such as syncing tags with other systems or generating reports.
  • Filtering or categorizing content based on tags retrieved dynamically.

For example, a user might want to get all tags to present them in a dropdown menu in another application or to analyze tag usage across their documentation.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description When "Set Automatically" is selected, describe what you want to do (e.g., "List all tags"). This text helps the system automatically select the appropriate resource and operation.

Note: For this specific Resource-Operation ("Tag" + "Get Many"), typically the "Tool Description" would be set to "Set Automatically" with a relevant description like "List all tags," or "Set Manually" selecting "Tag" as resource and "Get Many" as operation.

Output

The output is an array of JSON objects representing the tags retrieved from the BookStack API. Each item corresponds to one tag resource with its properties as returned by the API under the json field.

The structure of each tag object depends on the BookStack API response but generally includes fields such as tag ID, name, and possibly metadata related to the tag.

No binary data output is involved in this operation.

Example output snippet (conceptual):

[
  {
    "id": 1,
    "name": "Documentation",
    "created_at": "2023-01-01T12:00:00Z",
    ...
  },
  {
    "id": 2,
    "name": "API",
    "created_at": "2023-02-15T08:30:00Z",
    ...
  }
]

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL of the BookStack API must be provided in the credentials.
  • The node uses HTTP GET requests to fetch the list of tags.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid base URL or network connectivity issues can prevent communication with the BookStack API.
    • If no tags exist, the output will be an empty array; ensure tags are created in BookStack before fetching.

  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; verify and update credentials.
    • HTTP 404 or similar errors may indicate incorrect API endpoint URLs or misconfigured base URL.
    • Rate limiting or server errors from BookStack API should be handled by retrying after some delay.

Links and References

Discussion