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 various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Book resource with the Get Many operation, it retrieves multiple book records from the BookStack system.
Common scenarios where this node is beneficial include:
- Fetching a list of all books available in a BookStack instance for reporting or synchronization.
- Retrieving books to display summaries or indexes in other applications.
- Automating workflows that require bulk access to book metadata.
Practical example:
- You want to get all books from your BookStack knowledge base to generate an external catalog or to analyze which books are most frequently updated.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: either "Set Automatically" (based on a text request) or "Set Manually" (explicit selection). |
| Request Description | When "Set Automatically" is chosen, describe what you want to do in natural language (e.g., "List all books"). The system uses this description to infer the resource and operation. |
Note: For this specific Resource-Operation combination ("Book" + "Get Many"), the relevant properties are primarily these two, since the node will perform a GET request to fetch multiple books.
Output
The output is an array of JSON objects representing the retrieved books. Each item corresponds to one book resource returned by the BookStack API under the data property of the response.
The structure of each book object typically includes fields like:
id: Unique identifier of the book.name: The name/title of the book.description: A textual description of the book.- Other metadata fields as provided by the BookStack API.
No binary data output is involved in this operation.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API token credential configured in n8n with:
- Base URL of the BookStack API.
- Authentication token and secret.
- The node uses HTTP requests authenticated with these credentials to interact with the BookStack API.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing an invalid base URL or network connectivity issues will prevent API calls.
- If using automatic mode, ambiguous or unclear request descriptions may lead to incorrect resource or operation inference.
Error messages:
- Authentication errors usually indicate invalid tokens or misconfigured credentials.
- HTTP 404 errors may occur if the endpoint URL is malformed or the resource does not exist.
- Parsing errors might happen if the API response format changes unexpectedly.
Resolutions:
- Verify API credentials and ensure they have sufficient permissions.
- Confirm the base URL points correctly to the BookStack API endpoint.
- Use clear and precise descriptions when using automatic mode or switch to manual mode for explicit control.