BookStackInstall

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 Shelf resource with the Move operation, it enables relocating a shelf or moving related resources (like books or chapters) between shelves or books.

Common scenarios where this node is beneficial include:

• Organizing content collections by moving shelves to different categories.
• Reorganizing documentation structure by moving books or chapters between shelves.
• Automating content management workflows in BookStack via n8n.

For example, you could use this node to move a shelf named "API Docs" to a new parent shelf or relocate a book from one shelf to another programmatically.

Properties

Note: For the Shelf - Move operation, when set manually, you would specify the resource as "Shelf" and operation as "Move" along with the required parameters like the shelf ID and target location (handled internally).

Output

The node outputs JSON data representing the response from the BookStack API after performing the move operation. This typically includes details about the moved shelf or resource, confirming the new location or updated state.

If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node expects the base URL and authentication tokens to be configured in the credentials.
• No additional external dependencies are needed beyond the BookStack API access.

Troubleshooting

• Common issues:

  • Incorrect or missing shelf/resource IDs can cause failures.
  • Insufficient permissions in BookStack API credentials may prevent moving resources.
  • Malformed request descriptions when using automatic mode might lead to incorrect operation/resource detection.

• Error messages:

  • API errors returned from BookStack will appear in the output's error field.
  • Authentication errors indicate invalid or missing API tokens.
  • Validation errors occur if required parameters like IDs are missing.

• Resolutions:

  • Verify that the correct shelf ID and target location are provided.
  • Ensure the API key has sufficient permissions to perform move operations.
  • When using automatic mode, provide clear and concise request descriptions.

Links and References

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