Actions40
- Role Actions
- Page Actions
- Chapter Actions
- Book Actions
- Shelf Actions
- User Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Tag resource with the Get Many operation, it retrieves a list of tags from the BookStack system.
Common scenarios where this node is beneficial include:
- Fetching all tags available in a BookStack instance to display or process them elsewhere.
- Automating workflows that require tag data, such as categorizing content or syncing tags with other systems.
- Building dashboards or reports based on tag usage.
Practical example:
- You want to get all tags used in your documentation platform to analyze which topics are most tagged or to bulk update content associated with certain tags.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually". |
| Request Description | (Shown only if "Tool Description" is set to "Set Automatically") Describe what you want to do in natural language; the system will try to infer the appropriate resource and operation. |
For this specific Resource-Operation (Tag - Get Many), typically you would use:
- Tool Description: Usually "Set Automatically" or "Set Manually" depending on user preference.
- Request Description: A text description like "List all tags" when using automatic mode.
Output
The output is an array of JSON objects representing the retrieved tags. Each item corresponds to one tag resource returned by the BookStack API under the json field.
The structure of each tag object depends on the BookStack API response but generally includes fields such as tag ID, name, and possibly metadata related to the tag.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The node expects the base URL and authentication tokens to be configured in the credentials.
- The BookStack API must be accessible from the environment where n8n runs.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Network connectivity problems to the BookStack server.
- Using "Set Automatically" mode with ambiguous or unclear request descriptions may lead to incorrect resource or operation detection.
Error messages:
- Authentication errors: Check that the API token and base URL are correctly set.
- HTTP errors (e.g., 404, 500): Verify the BookStack API endpoint availability and correctness.
- Parsing errors: Ensure the request description is clear if using automatic mode.