Actions40
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API to manage "Shelf" resources, specifically supporting the deletion of a shelf by its ID. It allows users to delete a shelf from their BookStack instance either by manually specifying the resource and operation or by describing the request in natural language for automatic interpretation.
Common scenarios where this node is beneficial include:
- Automating the cleanup of outdated or unused shelves in a documentation system.
- Integrating shelf management into larger workflows that maintain or reorganize content collections.
- Programmatically removing shelves based on dynamic conditions or external triggers.
For example, a user might configure the node to delete a shelf with a specific ID when a project is archived, ensuring the documentation structure stays current without manual intervention.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually". |
| Request Description | (Shown if "Set Automatically") A text description of what you want to do; the system uses this to infer the resource and operation automatically. Example: "Delete shelf with ID 123". |
| ID | The unique identifier of the shelf to delete. Required when deleting a shelf. |
Output
The node outputs JSON data representing the response from the BookStack API after attempting to delete the specified shelf. Typically, this will be an empty object or confirmation of deletion if successful.
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 of the BookStack instance and authentication tokens to be configured in the credentials.
- The BookStack API must be accessible from the environment where n8n runs.
Troubleshooting
- Missing or invalid ID: If the ID property is not provided or incorrect, the API call will fail. Ensure the correct shelf ID is supplied.
- Authentication errors: If the API key or token is invalid or missing, the node will throw an authentication error. Verify credentials are correctly set up.
- Network issues: Connectivity problems to the BookStack API endpoint can cause failures. Check network access and API availability.
- Permission denied: The authenticated user must have permission to delete shelves. Lack of permissions will result in an authorization error.
- Automatic mode parsing errors: When using "Set Automatically", ambiguous or incomplete descriptions may lead to incorrect resource or operation detection. Use clear and specific request descriptions or switch to manual mode.
Links and References
- BookStack API Documentation
- n8n HTTP Request Node Documentation (for understanding underlying HTTP calls)