Actions22
Overview
This node integrates with the BookStack platform to manage various resources such as books, pages, shelves, and chapters. Specifically, for the Shelf - Create operation, it allows users to create a new shelf in BookStack by specifying its name, description, associated books, and tags.
Common scenarios where this node is beneficial include:
- Organizing collections of books into categorized shelves.
- Automating the creation of shelves based on external data or workflows.
- Tagging and describing shelves for better content management and retrieval.
For example, a user could automate the creation of a shelf named "Science Fiction" with a description and add specific book IDs to it, along with relevant tags like "sci-fi", "novel", and "2024 releases".
Properties
| Name | Meaning |
|---|---|
| Name | The name of the shelf to be created. Must be a string up to 255 characters. |
| Description | A textual description of the shelf, up to 1900 characters. |
| Books | Comma-separated list of book IDs (numbers) to add to the shelf, e.g., "123,456,789". |
| Tags | Comma-separated list of tags to assign to the shelf, e.g., "tag1, tag2, tag3". |
Output
The node outputs JSON objects representing the created shelf resource as returned by the BookStack API. The output includes all properties of the shelf such as its ID, name, description, associated books, tags, and any other metadata provided by the API.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The node uses HTTP requests to communicate with the BookStack REST API endpoints.
- Proper configuration of the BookStack API credentials within n8n is necessary.
Troubleshooting
- Missing Required Fields: If the "Name" property is empty or missing, the node will fail because the API requires a shelf name.
- Invalid Book IDs: Providing non-numeric or malformed book IDs in the "Books" field may cause errors or unexpected behavior.
- API Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to create shelves.
- Tag Formatting: Tags must be comma-separated strings; improper formatting might lead to incorrect tagging or API rejection.
- Error Messages: The node throws errors with messages from the BookStack API or generic messages if the request fails. Check the error message for details and verify input parameters accordingly.