BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

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 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 documentation workflows that require tag metadata retrieval.
  • Integrating BookStack tagging data into other systems or reports.

Practical example:

  • You want to retrieve the details of a tag with a known ID to display or process it further in your workflow.

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 what you want to do in natural language; the system attempts to 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, Update, and Delete operations.

Output

The node outputs JSON data representing the requested Tag resource from the BookStack API. The structure corresponds directly to the API response for a single tag, typically including fields such as the tag's ID, name, description, and any other metadata provided by BookStack.

No binary data output is produced by this operation.

Example output snippet (conceptual):

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

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The node expects the base URL of the BookStack instance and authentication tokens configured in the credentials.
  • No additional external dependencies beyond the BookStack API and n8n's HTTP request capabilities.

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 provided.
  • Authentication errors: If the API key or token is invalid or missing, requests will fail. Verify credentials are correctly set up.
  • Resource not found: If the tag ID does not exist, the API returns a 404 error. Confirm the tag exists in BookStack.
  • Automatic detection issues: When using automatic mode with a natural language description, ambiguous or unclear descriptions may lead to incorrect resource or operation detection. Use manual mode or clarify the description.

Links and References

Discussion