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, and shelves. Specifically, the Update Book operation allows users to modify existing book resources by changing their name and description.

Common scenarios for this node include:

  • Updating metadata of a book in a documentation system.
  • Renaming a book or revising its description to reflect new content.
  • Automating updates to book details based on external triggers or workflows.

Practical example:

  • A user wants to update the title and description of a book called "API Documentation" after adding new chapters. They provide the book's ID along with the new name and description, and the node sends an update request to BookStack.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if Tool Description is "automatic") Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Update the book titled 'API Guide' with a new description."
ID The unique identifier of the book resource to update. Required for update operations.
Name The new name/title of the book. Required for update operations on books.
Description The new description text for the book. Optional but recommended for update operations.

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 snippet (simplified):

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

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n with base URL and token information.
  • The node uses HTTP requests authenticated with a token header to communicate with the BookStack API.

Troubleshooting

  • Missing or invalid ID: Update operations require a valid book ID. Ensure the ID corresponds to an existing book in BookStack.
  • Authentication errors: Verify that the API token and base URL credentials are correctly set up and have sufficient permissions.
  • Invalid property values: The name property is required and must be a non-empty string. The description can be empty but should be a string.
  • API endpoint errors: If the BookStack API returns errors (e.g., 404 Not Found), confirm the resource exists and the URL is correct.
  • Automatic detection issues: When using automatic mode with natural language descriptions, ambiguous or incomplete requests may lead to incorrect resource or operation detection. In such cases, switch to manual mode.

Links and References

Discussion