BookStack icon

BookStack

Consume BookStack API

Overview

This node integrates with the BookStack API, allowing users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Book resource with the Delete operation, it enables deleting a book by 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 delete a book from BookStack when a related project is archived in another system, ensuring that 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 if "Set Automatically" is chosen) Describe your request in natural language; 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 an error occurs, 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 to 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.
  • 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 communication with the BookStack server.
  • Error messages and resolutions:

    • "Resource not found": The specified book ID does not exist. Verify the ID is correct.
    • 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.

Links and References

Discussion