BookStack

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 User resource with the Update operation, it allows updating user details by specifying the user ID and the data to update.

The node supports two modes of operation:

• Automatic mode: You provide a natural language description of your request (e.g., "Update user with ID 123"), and the node attempts to parse and determine the appropriate resource and operation automatically.
• Manual mode: You explicitly select the resource ("User") and operation ("Update") and provide required parameters like the user ID.

Typical use cases include automating user management tasks in BookStack, such as modifying user information programmatically within an n8n workflow.

Properties

Output

The node outputs JSON data representing the response from the BookStack API after performing the update operation on the user resource. This typically includes the updated user object with its properties as returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": 123,
  "name": "Updated User Name",
  "email": "user@example.com",
  "role": "editor",
  ...
}

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.
  • Authentication token and secret.
• The node uses HTTP requests authenticated with these credentials to interact with the BookStack API.

Troubleshooting

• Missing or invalid ID: The update operation requires a valid user ID. If omitted or incorrect, the API will return an error. Ensure the ID parameter is provided and corresponds to an existing user.
• Authentication errors: If the API credentials are missing, invalid, or expired, requests will fail. Verify that the API token and base URL are correctly set in the credentials.
• Incorrect automatic detection: When using automatic mode, the natural language parsing might misinterpret the intended resource or operation. In such cases, switch to manual mode and specify the resource and operation explicitly.
• API endpoint errors: If the BookStack API is unreachable or returns errors (e.g., 404 Not Found, 400 Bad Request), check network connectivity, API availability, and correctness of parameters.

Links and References

• BookStack Official Documentation
• BookStack API Documentation
• n8n Documentation