BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

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

Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as removing outdated or irrelevant books programmatically, cleaning up test data, or integrating BookStack content lifecycle management into broader automation pipelines.

Practical example: Automatically deleting a book from BookStack when a related project is archived or removed in another system, ensuring your documentation stays current without manual intervention.

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 what you want to do; the system will infer the resource and operation automatically. Example: "Delete the book with ID 123".
ID The unique identifier of the book to delete. Required for Delete operation.

Output

The node outputs JSON data representing the response from the BookStack API after attempting to delete the specified book. Typically, this will be an empty object or confirmation message indicating successful deletion.

If the node encounters an error during deletion, the output JSON will contain an error field with the error message.

No binary data output is produced by this node.

Example output on success:

{}

Example output on failure:

{
  "error": "Resource not found"
}

Dependencies

  • Requires connection credentials for the BookStack API, including:
    • Base URL of the BookStack instance.
    • An API token and secret for authentication.
  • The node uses HTTP requests authenticated via these credentials to interact with the BookStack REST API.
  • No additional external dependencies are required.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent book ID will result in an error from the API.
    • Incorrect or missing API credentials will cause authentication failures.
    • Network connectivity issues can prevent the node from reaching the BookStack server.

  • Error messages and resolutions:

    • "Resource not found": The specified book ID does not exist. Verify the ID is correct.
    • "Unauthorized" or authentication errors: Check that the API token and secret are valid and have sufficient permissions.
    • Timeout or network errors: Ensure the BookStack server is reachable and the base URL is correctly configured.

  • When using automatic tool description mode, ensure the request description clearly specifies the intent and includes the book ID to avoid incorrect operation detection.

Links and References

Discussion