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, allowing users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Chapter - Get operation, it retrieves detailed information about a single chapter by its ID.
Common scenarios where this node is beneficial include:
- Fetching chapter details to display or process in workflows.
- Automating documentation retrieval from BookStack.
- Integrating BookStack content into other systems or reports.
For example, you might use this node to get the metadata and content of a specific chapter to generate a summary report or to synchronize chapter data with another knowledge management system.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown if "Set Automatically" is selected) Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Get chapter with ID 123". |
| ID | The unique identifier of the chapter resource to retrieve. Required for operations: get, update, delete. |
Output
The node outputs JSON data representing the requested chapter resource. The structure corresponds directly to the BookStack API's chapter object, typically including fields such as:
id: Chapter IDname: Chapter name/titledescription: Chapter description (if any)book_id: ID of the book the chapter belongs to- Other metadata fields provided by the BookStack API for chapters
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a BookStack instance via its API.
- Requires an API authentication token credential configured in n8n with:
- Base URL of the BookStack API
- Authentication token and secret for API access
Troubleshooting
- Missing or invalid ID: The "ID" property is required for the Get operation. Ensure you provide a valid chapter ID; otherwise, the API call will fail.
- Authentication errors: If the API credentials are incorrect or expired, the node will return authorization errors. Verify the API token and base URL.
- Resource not found: If the chapter ID does not exist, the API will return a 404 error. Confirm the ID is correct.
- Automatic mode parsing issues: When using "Set Automatically" with a natural language description, ambiguous or incomplete descriptions may cause incorrect resource or operation selection. Use manual mode for precise control.