BookStack

Overview

This node integrates with the BookStack API, enabling users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the User resource with the Create operation, it allows creating new user entries in the BookStack system.

The node supports two modes of operation:

• Automatic mode: The user provides a natural language description of the desired action (e.g., "Create a new page about API documentation"), and the node attempts to infer the appropriate resource and operation.
• Manual mode: The user explicitly selects the resource and operation and provides the necessary parameters.

Typical use cases include automating content management workflows, such as programmatically adding new users or other resources to BookStack based on dynamic input or external triggers.

Example: Automatically create a new user in BookStack when a new employee joins your company by providing a descriptive request or manually specifying user details.

Properties

Note: For the User - Create operation specifically, no additional properties are defined in the provided snippet beyond these general ones. In manual mode, the user would typically specify user-related fields (not shown here) such as name, email, etc., but those are not detailed in the provided code.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the BookStack API for the requested operation.

For the Create User operation, the json output field will contain the newly created user's data as returned by the BookStack API, including fields like user ID, name, email, and other user attributes.

No binary data output is indicated in the source code.

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

• Common issues:

  • Incorrect or missing API credentials will cause authentication failures.
  • Providing incomplete or invalid user data may result in API errors.
  • Using automatic mode with ambiguous or unclear descriptions might lead to incorrect resource or operation detection.

• Error messages:

  • Errors returned from the BookStack API will be passed through in the output under an error field if "Continue On Fail" is enabled.
  • Authentication errors typically indicate invalid or expired tokens; verify credentials.
  • Validation errors from the API usually mean required fields are missing or malformed; ensure all mandatory user fields are provided.

Links and References

• BookStack Official API Documentation
• BookStack GitHub Repository