BookStack icon

BookStack

Consume BookStack API

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 - Delete operation, it allows you to delete a user resource by specifying its ID.

Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as removing obsolete or inactive users programmatically, cleaning up user accounts, or integrating user lifecycle management into broader automation pipelines.

Practical example: Automatically deleting a user from BookStack when they leave an organization by triggering this node with the user's ID.


Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if "Set Automatically" is chosen) Describe your request in natural language; the system will try to infer the resource and operation automatically. Example: "Delete user with ID 123".
ID The unique identifier of the user resource to delete. Required for delete operation.

Output

The output JSON contains the response from the BookStack API after attempting to delete the specified user. Typically, a successful delete operation returns an empty object or confirmation message indicating the user was deleted.

If the operation fails, the output JSON will contain an error field with the error message explaining what went wrong.

No binary data output is produced by this node.


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.
    • Token and token secret for authorization.
  • The node uses HTTP DELETE requests to the endpoint /api/users/{id} to perform deletion.

Troubleshooting

  • Common issues:

    • Invalid or missing user ID: Ensure the ID provided corresponds to an existing user.
    • Authentication errors: Verify that the API token credentials are correct and have sufficient permissions.
    • Network or connectivity problems: Confirm that the BookStack API base URL is reachable from n8n.
  • Error messages:

    • "error": "User not found" — The specified user ID does not exist. Check the ID.
    • "error": "Unauthorized" — API credentials are invalid or lack permission. Reconfigure credentials.
    • Other HTTP errors (e.g., 400, 403, 500) indicate issues with the request or server; review API documentation and logs.

Links and References

Discussion