Actions56
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API, specifically allowing users to interact with the "Shelf" resource among others. The "Get" operation for the Shelf resource retrieves detailed information about a specific shelf by its ID.
Common scenarios where this node is beneficial include:
- Fetching metadata and details of a particular shelf in a BookStack instance.
- Automating documentation workflows that require retrieving shelf information.
- Integrating BookStack shelf data into other systems or dashboards.
Practical example:
- You want to retrieve the details of a shelf with a known ID to display its name, description, and contained books in an external application or workflow.
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 try to automatically select the appropriate resource and operation. Example: "Get shelf with ID 123". |
| ID | (Required) The unique identifier of the shelf resource you want to get. |
Output
The output JSON contains the full response from the BookStack API for the requested shelf. This typically includes fields such as:
id: The shelf's unique identifier.name: The name of the shelf.description: A textual description of the shelf.- Other metadata related to the shelf, such as creation date, update date, and possibly the list of books contained within the shelf.
No binary data output is produced by this operation.
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.
- HTTP requests are made to the BookStack API endpoint
/api/shelfs/{id}using GET method.
Troubleshooting
Common issues:
- Invalid or missing shelf ID: The node requires a valid shelf ID; providing an empty or incorrect ID will result in an error.
- Authentication errors: Ensure the API key/token credentials are correctly set up and have sufficient permissions.
- Network or connectivity problems: Verify that the BookStack instance URL is reachable from n8n.
Error messages:
- Errors returned from the BookStack API will be passed through, often indicating invalid ID or permission denied.
- If the node fails due to missing parameters, ensure the "ID" property is provided when using manual or automatic tool description modes.