BookStack

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 Create operation, it allows creating a new user in the BookStack system.

The node supports two modes of operation:

• Automatic mode: You provide a natural language description of what you want to do (e.g., "Create a new user account"), and the node attempts to parse this description to determine the appropriate resource and operation.
• Manual mode: You explicitly select the resource ("User") and operation ("Create") and provide the required parameters directly.

Practical examples where this node is beneficial include automating user onboarding by programmatically creating user accounts in BookStack based on external triggers or workflows, or integrating user management into larger automation pipelines.

Properties

For the User - Create operation specifically, no additional input properties are explicitly defined in the provided snippet, implying that the node relies on the automatic parsing of the request description or manual selection of resource and operation. Additional user-specific fields might be supported but are not shown here.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the full JSON response from the BookStack API after creating the user resource. This typically includes details of the newly created user such as their ID, name, email, and other metadata returned by the API.

If an error occurs during processing, and the node is configured to continue on failure, the output JSON will contain an error field with the error message.

No binary data output is indicated.

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 an ambiguous or unsupported request description in automatic mode may lead to incorrect resource/operation detection.
  • Missing required parameters when manually setting resource and operation can cause API errors.
• Error messages:
  • Authentication errors usually indicate invalid or expired API tokens; verify and update credentials.
  • Validation errors from the API may indicate missing required fields; ensure all mandatory user creation fields are provided.
  • Network or connectivity errors suggest checking the base URL and network access.

Links and References

• BookStack API Documentation
• BookStack Official Website