BookStack

Overview

This node integrates with the BookStack API to manage various BookStack resources, including Tags. Specifically, for the Tag - Update operation, it updates an existing tag resource by its ID. The node supports both manual and automatic modes for specifying the resource and operation:

• In manual mode, you explicitly select the resource (Tag) and operation (Update), then provide the Tag ID and any fields to update.
• In automatic mode, you describe your request in natural language, and the node attempts to infer the resource and operation.

This node is useful for automating content management workflows in BookStack, such as updating tags programmatically based on external triggers or data changes.

Practical Example

• Automatically update a tag's name or description when a related event occurs in another system.
• Batch update multiple tags by feeding IDs and new values into the node.
• Use natural language descriptions to simplify integration without manually selecting operations.

Properties

Output

The node outputs JSON data representing the updated Tag resource as returned by the BookStack API. The structure typically includes all properties of the Tag after the update, such as its ID, name, description, and other metadata.

No binary data output is involved in this operation.

Example output snippet (simplified):

{
  "id": 123,
  "name": "Updated Tag Name",
  "description": "Updated 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 with JSON payloads to interact with the BookStack API.

Troubleshooting

• Missing or invalid ID: The update operation requires a valid Tag ID. Ensure the ID is provided and correct.
• Authentication errors: Verify that the API credentials are correctly set up and have sufficient permissions.
• Incorrect property values: When setting properties manually, ensure they conform to expected types and constraints.
• Automatic mode inference failures: If the natural language description is ambiguous or incomplete, the node may not correctly infer the operation or resource. Try switching to manual mode or clarifying the description.
• API endpoint errors: Check the BookStack API documentation for valid endpoints and required fields if unexpected errors occur.

Links and References

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