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 Tag resource with the Get operation, it retrieves a single tag by its ID.

Common scenarios where this node is beneficial include:

  • Fetching detailed information about a specific tag in a BookStack instance.
  • Automating workflows that require tag metadata retrieval for categorization or filtering.
  • Integrating BookStack tagging data into other systems or dashboards.

Practical example:

  • You want to get details of a tag with a known ID to display its name and description in an external reporting tool.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if "Set Automatically" is selected) Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Get tag with ID 123".
ID The unique identifier of the tag resource to retrieve. Required for Get operation.

Output

The node outputs JSON data representing the retrieved tag object from the BookStack API. This typically includes fields such as the tag's ID, name, description, and any other metadata provided by the API.

No binary data output is involved.

Example output structure (simplified):

{
  "id": 123,
  "name": "example-tag",
  "description": "A sample tag description",
  ...
}

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 interact with the BookStack API.

Troubleshooting

  • Missing or invalid ID: The Get operation requires a valid tag ID. If omitted or incorrect, the API will return an error. Ensure the ID is correctly set.
  • Authentication errors: If the API token or base URL is misconfigured, requests will fail with authorization errors. Verify credentials are correct and have sufficient permissions.
  • Resource not found: If the tag ID does not exist, the API returns a 404 error. Confirm the tag exists in BookStack.
  • Network issues: Connectivity problems to the BookStack server will cause request failures. Check network access and API availability.

Links and References

Discussion