BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, chapters, and shelves. Specifically, the Chapter - Update operation allows users to update an existing chapter's details by specifying its ID and new properties like name.

Common scenarios for this node include:

  • Updating chapter titles or metadata in a documentation system.
  • Modifying chapter information programmatically as part of a content management workflow.
  • Automating updates to book structures in BookStack based on external triggers or data changes.

For example, you might use this node to rename a chapter after receiving updated content from an editorial system or to correct metadata 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 selected) Describe your request in natural language; the system will infer the resource and operation. Example: "Update chapter title in book"
ID The unique identifier of the chapter to update (required)
Name The new name/title of the chapter (required when updating)

Output

The node outputs JSON data representing the updated chapter resource as returned by the BookStack API. This typically includes fields such as the chapter's ID, name, description, and any other metadata provided by the API response.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "Updated Chapter Title",
  "description": "Optional description if supported",
  ...
}

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n with base URL and token details.
  • The node uses HTTP methods (PUT) to send update requests to the endpoint /chapters/{id}.

Troubleshooting

  • Missing or invalid ID: The update operation requires a valid chapter ID. Ensure the ID parameter is correctly set and corresponds to an existing chapter.
  • Authentication errors: Verify that the API token and base URL credentials are correctly configured and have sufficient permissions to update chapters.
  • Invalid property values: The "Name" field must be non-empty when updating. Empty or invalid names may cause API errors.
  • API endpoint issues: Confirm that the BookStack API endpoint is reachable and that the version matches expected API paths.
  • Automatic mode parsing failures: If using automatic mode with a natural language description, ambiguous or incomplete descriptions may lead to incorrect resource/operation inference. In such cases, switch to manual mode.

Links and References

Discussion