BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API to manage book-related resources such as books, pages, chapters, and shelves. Specifically, the Update Book operation allows users to modify existing book entries by changing their name and description.

Common scenarios where this node is beneficial include:

Automatically updating book metadata in a documentation system.
Synchronizing book information from other content management systems.
Editing book details as part of a larger automated workflow for content updates.

For example, you could use this node to update the title and description of a book after receiving new input from a form or another system, ensuring your BookStack instance stays current without manual intervention.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: "Set Automatically" or "Set Manually".
Request Description	(Shown if "Set Automatically") Describe what you want to do; the system infers resource and operation automatically. Example: "Update the book titled 'API Guide'."
ID	The unique identifier of the book to update. Required for update operations.
Name	The new name/title of the book. Required when updating a book.
Description	The new description text for the book. Optional when updating a book.

Output

The node outputs JSON data representing the updated book resource as returned by the BookStack API. This typically includes fields such as the book's ID, name, description, creation and update timestamps, and other metadata.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": 123,
  "name": "Updated Book Title",
  "description": "Updated description of the book.",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-02-01T15:30:00Z",
  ...
}

Dependencies

Requires an API key credential for authenticating with the BookStack API.
The base URL of the BookStack instance must be configured in the credentials.
The node uses HTTP methods PUT to send update requests to the endpoint /books/{id}.

Troubleshooting

Missing or invalid ID: The update operation requires a valid book ID. Ensure the ID property is set and corresponds to an existing book.
Authentication errors: Verify that the API token and base URL are correctly configured in the credentials.
Validation errors: If the name field is empty or invalid, the API may reject the request. Always provide a valid name when updating.
Network issues: Check connectivity to the BookStack server and ensure the API endpoint is reachable.
Automatic mode parsing failures: When using automatic tool description mode, ambiguous or incomplete descriptions might cause incorrect resource or operation detection. Use manual mode if needed.