Actions40
- Role Actions
- Page Actions
- Chapter Actions
- Book Actions
- Shelf Actions
- User Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API to manage "Shelf" resources, specifically supporting the Update operation. It allows users to update the properties of an existing Shelf in a BookStack instance.
Typical use cases include:
- Renaming a shelf or changing its description.
- Automating updates to collections of bookshelves based on external triggers or workflows.
- Keeping metadata about shelves up-to-date without manual intervention.
For example, you might use this node to update the name and description of a bookshelf after receiving new information from another system or user input.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown if Tool Description is "Set Automatically") Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Update the shelf named 'Science Fiction' to 'Sci-Fi Collection'." |
| ID | The unique identifier of the Shelf resource to update. Required for update operations. |
| Name | The new name for the Shelf. This is required when updating a shelf. |
| Description | The new description text for the Shelf. Optional but can provide additional context. |
Output
The node outputs JSON data representing the updated Shelf resource as returned by the BookStack API. The structure typically includes fields such as:
id: The Shelf's unique identifier.name: The updated name of the Shelf.description: The updated description.- Other metadata fields as provided by the API response.
No binary data output is produced by this node.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API authentication token credential configured in n8n to authorize requests.
- The base URL of the BookStack API and the authentication tokens must be set in the node credentials.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid Shelf ID. Ensure the ID is correct and corresponds to an existing Shelf.
- Authentication errors: If the API token or base URL is incorrect or expired, the node will fail to authenticate. Verify credentials in n8n settings.
- Invalid property values: Providing empty or invalid names may cause the API to reject the update. Make sure the "Name" field is non-empty.
- API endpoint issues: If the BookStack instance URL changes or the API version is incompatible, requests may fail. Confirm the API base URL and version compatibility.
Common error messages usually relate to HTTP status codes like 401 Unauthorized, 404 Not Found (invalid ID), or 400 Bad Request (invalid parameters). Checking the API response message helps identify the exact issue.