BookStack icon

BookStack

Consume BookStack API

Actions40

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 - 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. For example, an organization might use this node to automatically delete user accounts that are no longer active based on external triggers or scheduled cleanups.

Properties

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

Output

The output is a JSON object representing the response from the BookStack API after attempting to delete the user. Typically, for a successful delete operation, the API returns confirmation or an empty object. If the deletion fails, the output contains an error message describing the failure.

No binary data output is produced by this node.

Example output structure:

{
  "json": {
    // API response confirming deletion or error details
  }
}

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 the deletion.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent user ID will result in an error from the API.
    • Incorrect or missing API credentials will cause authentication failures.
    • Network connectivity issues between n8n and the BookStack server can prevent successful requests.

  • Error messages:

    • "error": "User not found" — The specified user ID does not exist. Verify the ID.
    • Authentication errors — Check that the API token and base URL are correctly set in credentials.
    • HTTP 4xx or 5xx errors — Review API permissions and server status.

  • Resolution tips:

    • Double-check the user ID input.
    • Ensure API credentials are valid and have sufficient permissions.
    • Test connectivity to the BookStack API outside n8n to isolate network issues.

Links and References

Discussion