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 content resources such as books, pages, chapters, and shelves. Specifically for the Chapter - Create operation, it allows users to create a new chapter within a specified book in BookStack.
Common scenarios where this node is beneficial include:
- Automating documentation workflows by programmatically adding chapters to books.
- Integrating content management into broader automation pipelines.
- Creating structured knowledge bases or manuals dynamically based on external triggers or inputs.
For example, you could use this node to automatically add a new chapter titled "API Integration" to an existing book whenever a new API version is released.
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") Describe your request in natural language, e.g., "Create a new chapter about API usage". The system will parse this to select resource and operation automatically. |
| Name | The name/title of the chapter to be created. This is required. |
| Book ID | The ID of the book to which the new chapter belongs. This is required. |
Output
The node outputs JSON data representing the response from the BookStack API after creating the chapter. This typically includes details of the newly created chapter such as its ID, name, associated book ID, and other metadata returned by the API.
No binary data output is produced by this node.
Example output structure (simplified):
{
"id": 123,
"name": "Chapter Name",
"book_id": 45,
"created_at": "2024-01-01T12:00:00Z",
...
}
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The node expects the base URL and authentication tokens for the BookStack instance to be configured in the credentials.
- HTTP requests are made to the BookStack REST API endpoints under
/api/chapters.
Troubleshooting
- Missing Required Fields: Ensure that both "Name" and "Book ID" are provided when creating a chapter manually. Omitting these will cause API errors.
- Invalid Book ID: If the provided Book ID does not exist or is incorrect, the API will return an error indicating the book was not found.
- Authentication Errors: Verify that the API token and base URL credentials are correctly set up and valid.
- Automatic Mode Parsing Issues: When using automatic mode with a natural language description, ambiguous or incomplete descriptions may lead to incorrect resource or operation selection. In such cases, switch to manual mode for precise control.
- API Rate Limits or Connectivity: Network issues or API rate limits can cause request failures; check connectivity and API usage policies.