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 to manage attachments and other resources such as books, pages, chapters, shelves, users, roles, and tags. Specifically for the Attachment - Create operation, it allows users to create new attachments within the BookStack system.
The node supports two modes of operation:
- Automatic mode: The user provides a natural language description of the request (e.g., "Create a new attachment for page 123"), and the node attempts to parse this description to determine the resource and operation automatically.
- Manual mode: The user explicitly selects the resource ("Attachment") and operation ("Create") and provides the required parameters directly.
Typical use cases include automating content management workflows in BookStack, such as programmatically adding files or attachments to pages or other entities, either by describing the desired action in plain language or by specifying exact parameters.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically: Use natural language description to auto-select resource and operation. - Set Manually: Explicitly select resource and operation. |
| Request Description | (Shown only if "Set Automatically" is selected) A string where you describe what you want to do, e.g., "Create a new page about API documentation". The system uses this to infer the resource and operation. |
Note: For the Attachment resource's Create operation, no additional specific input properties are defined in the provided snippet. In manual mode, the user would typically provide necessary fields like attachment details, but these are not explicitly shown here.
Output
The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the BookStack API for the performed operation.
For the Create Attachment operation, the json output will contain the newly created attachment's data as returned by the BookStack API, including identifiers and metadata.
If the node encounters errors during execution and "Continue On Fail" is enabled, the output for that item will contain an error field with the error message.
No binary data output is indicated in the source code.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API authentication token credential configured in n8n with:
- Base URL of the BookStack API.
- Token and token secret for authorization.
- The node uses HTTP requests with JSON payloads to communicate with the BookStack API.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Improperly formatted natural language descriptions may lead to incorrect resource or operation detection in automatic mode.
- Missing required parameters (like IDs or names) when using manual mode can cause API errors.
Error messages:
- Authentication errors: Verify API token and base URL configuration.
- Validation errors from the API: Check that all required fields for creating an attachment are provided.
- Parsing errors in automatic mode: Simplify or clarify the request description to improve detection accuracy.
Links and References
Note: This summary is based on static analysis of the provided source code and property definitions. Runtime behavior may depend on actual API responses and environment setup.