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 tags and other resources such as books, pages, chapters, shelves, users, roles, and attachments. Specifically for the Tag resource with the Update operation, it allows updating an existing tag by its ID.
The node supports two modes of operation:
- Automatic mode: You describe your request in natural language, and the node attempts to infer the resource and operation.
- Manual mode: You explicitly specify the resource (e.g., Tag) and operation (e.g., Update).
Typical use cases include updating metadata or properties of a tag within BookStack, such as changing its name or description. This is useful for organizing content better or correcting tag information.
Example scenario:
You want to update a tag's details by providing its ID and new values, either by describing the change in plain text or by manually specifying the parameters.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: "Set Automatically" (via natural language) or "Set Manually" (explicit selection). |
| Request Description | (Shown only if Tool Description is "automatic") A string where you describe what you want to do, e.g., "Update tag with ID 123". The system tries to parse this to select resource and operation automatically. |
| ID | The unique identifier of the tag resource to update. Required for update operations. |
Output
The node outputs JSON data representing the response from the BookStack API after performing the update operation on the tag. This typically includes the updated tag object with its properties as returned by the API.
If multiple input items are processed, the output is an array of JSON objects corresponding to each input item.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The base URL and authentication tokens must be configured in the node credentials.
- The node uses HTTP requests to communicate with the BookStack REST API endpoints.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid tag ID. If omitted or incorrect, the API will return an error. Ensure the ID parameter is provided and correct.
- Authentication errors: If the API key or token is missing or invalid, requests will fail. Verify that the API credentials are correctly set up in n8n.
- Incorrect resource or operation: When using automatic mode, ambiguous or unclear descriptions may cause wrong resource/operation detection. Use manual mode to avoid this.
- API endpoint errors: Network issues or incorrect base URL configuration can cause request failures. Confirm the base URL is correct and accessible.
- Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.