BookStack

Overview

This node integrates with the BookStack API to manage tags and other resources such as books, pages, chapters, shelves, users, roles, and attachments. Specifically for the Tag - Update operation, it allows updating an existing tag resource by specifying its ID and new properties.

Common scenarios where this node is beneficial include:

• Automating content management workflows in BookStack by programmatically updating tags.
• Synchronizing tag metadata from external systems into BookStack.
• Bulk updating tags based on dynamic input or conditions within an n8n workflow.

For example, you could use this node to update the name or description of a tag identified by its ID, helping keep your documentation organized and up-to-date.

Properties

Note: For the Tag resource, only the ID property is explicitly defined here for the update operation. Other editable fields like tag name or description are not shown in the provided properties snippet but may be supported internally or via automatic inference.

Output

The node outputs JSON data representing the updated tag resource as returned by the BookStack API. The output structure corresponds directly to the API response for the updated tag, typically including fields such as:

• id: The tag's unique identifier.
• name: The updated name of the tag.
• Other tag-related metadata fields as provided by the API.

If the node encounters an error during execution, the output JSON will contain an error field with the error message.

The node does not output binary data.

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.
  • Authentication tokens (token and token secret).
• The node uses HTTP requests with appropriate headers (Authorization and Content-Type) to communicate with the BookStack API.

Troubleshooting

• Missing or invalid ID: The update operation requires a valid tag ID. Ensure the ID is correctly provided; otherwise, the API will return an error.
• Authentication errors: If the API credentials are incorrect or expired, the node will fail to authenticate. Verify the API token and base URL configuration.
• API endpoint errors: If the BookStack API URL is misconfigured or the resource path is incorrect, requests will fail. Confirm the base URL ends correctly and the resource path matches /tags/{id}.
• Automatic detection issues: When using "Set Automatically," ambiguous or unclear request descriptions might lead to incorrect resource or operation detection. Use clear, concise descriptions or switch to manual mode.
• Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

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