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 various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the User resource with the Update operation, it allows updating user details by specifying the user ID and the fields to modify.
The node supports two modes of operation:
- Automatic mode: You provide a natural language description of your request, and the node attempts to infer the resource and operation.
- Manual mode: You explicitly select the resource and operation and provide necessary parameters.
Typical use cases include updating user information in BookStack, such as changing user details or permissions programmatically within an n8n workflow. For example, you might update a user's profile after receiving input from another system or automate user management tasks.
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 "Set Automatically" is selected) A text description of what you want to do; the system uses this to infer resource and operation. Example: "Update user with ID 123" |
| ID | The unique identifier of the user to update. Required for operations like get, update, and delete. |
Note: Since the provided properties JSON only includes these relevant to the User resource and Update operation, other resource-specific fields are not listed here.
Output
The node outputs the JSON response returned by the BookStack API after performing the update operation on the user resource. This typically includes the updated user object with its properties reflecting the changes made.
If the API returns binary data (not typical for user updates), it would be included accordingly, but this node primarily deals with JSON responses representing resource data.
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 sends HTTP requests to the BookStack API endpoints corresponding to the selected resource and operation.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid user ID. If omitted or incorrect, the API will return an error indicating the resource was not found.
- Authentication errors: Ensure that the API token and base URL are correctly set in the credentials. Authentication failures will result in 401 or 403 HTTP errors.
- Invalid request body: If required fields for the update are missing or malformed, the API may reject the request with validation errors.
- Automatic mode misinterpretation: When using automatic mode with natural language descriptions, ambiguous or unclear requests may lead to incorrect resource or operation detection. In such cases, switch to manual mode for precise control.