BookStack

Overview

This node integrates with the BookStack API to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Attachment resource with the Get Many operation, it retrieves a list of attachment resources from the BookStack system.

Common scenarios where this node is beneficial include:

• Automating retrieval of multiple attachments related to documentation or content stored in BookStack.
• Integrating BookStack attachments into workflows that require batch processing or analysis of files.
• Synchronizing or backing up attachments from BookStack to other systems.

For example, you might use this node to fetch all attachments associated with a particular book or page to process them further or to generate reports on file usage.

Properties

Note: Since the user specified Resource = Attachment and Operation = Get Many, these are the relevant input properties. The node also supports manual selection of resource and operation when "Set Manually" is chosen, but those are not shown here per the user's request.

Output

The output is an array of JSON objects representing the retrieved attachments. Each item corresponds to one attachment resource fetched from the BookStack API.

• The json field contains the full data object returned by the BookStack API for each attachment.
• The structure of each attachment object follows the BookStack API's response schema for attachments, typically including fields like ID, name, URL, size, and metadata.
• No binary data output is indicated for this operation; the node returns metadata about attachments rather than the attachment files themselves.

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 to be configured in the credentials.
• The HTTP requests are made to the /api/attachments endpoint using GET method with pagination support.

Troubleshooting

• Common issues:

  • Incorrect or missing API credentials will cause authentication failures.
  • Providing an invalid base URL or network connectivity issues can prevent successful API calls.
  • If the automatic detection of resource and operation is used, ambiguous or unclear request descriptions may lead to incorrect operation/resource selection.

• Error messages:

  • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
  • HTTP 404 errors may occur if the API endpoint is incorrect or the resource does not exist.
  • Rate limiting or server errors from BookStack API should be handled by retrying after some delay.

• To resolve issues, ensure credentials are correctly set, the BookStack instance is reachable, and the request description (if used) clearly specifies the intended action.

Links and References

• BookStack API Documentation
• n8n Documentation on Creating Custom Nodes
• BookStack Official Website