BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, chapters, and shelves. Specifically, the Page - Update operation allows users to update an existing page's details including its name and HTML content. This is useful for maintaining or revising documentation, articles, or any web content managed within BookStack.

Typical use cases include:

  • Updating the title or content of a page in a knowledge base.
  • Automating content revisions based on external triggers or workflows.
  • Synchronizing page content from other systems into BookStack.

For example, you might use this node to update a page titled "API Documentation" with new HTML content after changes are made in your source documents.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if Tool Description is "Set Automatically") Describe what you want to do; the system will infer resource and operation automatically. Example: "Update the page about API documentation."
ID The unique identifier of the page to update. Required for update operations.
Name The new name/title of the page. Required when updating a page.
HTML Content The updated HTML content of the page. Allows rich text formatting and structure.

Output

The node outputs JSON data representing the response from the BookStack API after the update request. This typically includes the updated page object with fields such as its ID, name, HTML content, and metadata.

No binary data output is produced by this node.

Example output snippet:

{
  "id": 123,
  "name": "Updated Page Title",
  "html": "<h1>Updated Content</h1><p>New information here.</p>",
  ...
}

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL of the BookStack API and tokens must be set in the node credentials.

Troubleshooting

  • Missing or invalid ID: The update operation requires a valid page ID. Ensure the ID property is correctly set.
  • Authentication errors: Verify that the API token credential is correct and has sufficient permissions.
  • Invalid HTML content: If the HTML content is malformed, the API may reject the update. Validate HTML before sending.
  • Automatic detection issues: When using automatic mode, ambiguous or unclear request descriptions may cause incorrect resource or operation selection. Use manual mode for precise control.
  • API endpoint errors: Confirm the BookStack API base URL is correct and accessible from n8n.

Links and References

Discussion