Actions22
Overview
This node integrates with BookStack, a platform for creating and managing documentation and knowledge bases. It allows users to manage various BookStack resources such as books, pages, shelves, and chapters through n8n workflows.
Specifically, the Create Book operation enables users to create a new book resource in BookStack by providing details like the book's name, description, default page template, and tags.
Common scenarios where this node is beneficial include:
- Automating the creation of structured documentation when new projects or products are initiated.
- Integrating BookStack content management into broader automation workflows, e.g., syncing with other content sources or triggering documentation updates.
- Bulk creating books based on external data feeds or user inputs.
Example: Automatically create a new book in BookStack whenever a new project is created in a project management tool, populating it with relevant metadata.
Properties
| Name | Meaning |
|---|---|
| Name | Name of the book (max 255 characters). This is a required field. |
| Description | Description of the book (max 1900 characters). Optional detailed information about the book. |
| Default Template ID | ID of the default template used for pages within this book. |
| Tags | Comma-separated list of tags associated with the book, used for categorization or filtering. |
Output
The node outputs JSON objects representing the created book resource as returned by the BookStack API. The output includes all properties of the newly created book, such as its unique identifier, name, description, tags (as an array of objects with tag names), and any other metadata provided or generated by BookStack.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a BookStack instance via an API key credential configured in n8n.
- The node uses HTTP requests to communicate with the BookStack API endpoints.
- Proper permissions on the BookStack API are necessary to create book resources.
Troubleshooting
- Missing Required Fields: If the "Name" property is not provided or empty, the node will fail because the API requires it.
- Invalid Tags Format: Tags must be provided as a comma-separated string; improper formatting may cause unexpected results.
- API Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to create books.
- API Endpoint Issues: Network connectivity problems or incorrect BookStack URL configuration can cause request failures.
- Error Messages: The node throws errors with messages from the BookStack API or generic messages if the request fails. Check the error message for clues, such as permission denied or validation errors.