BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API to manage content resources such as pages, books, chapters, and shelves. Specifically for the Page - Update operation, it allows updating an existing page's details including its name and HTML content. This is useful in scenarios where you want to programmatically modify documentation pages, articles, or any HTML-based content stored in BookStack.

Practical examples include:

  • Automatically updating a page’s content based on external data or events.
  • Editing page titles or HTML content in bulk via workflows.
  • Integrating with other systems to keep documentation synchronized.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually".
Request Description (Shown if Tool Description is automatic) A text description of what you want to do; used to auto-select resource and operation.
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 content editing.

Output

The node outputs JSON data representing the updated page resource returned by the BookStack API. This typically includes fields such as the page ID, name, HTML content, timestamps, and other metadata as provided by the API response.

If the node supports binary data output (not indicated here), it would represent file attachments or similar content, but for the Page Update operation, the output is purely JSON.

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API authentication token credential configured in n8n with base URL and tokens.
  • The node uses HTTP methods PUT to update the page resource at the endpoint /pages/{id}.

Troubleshooting

  • Missing or invalid ID: The update operation requires a valid page ID. Ensure the ID property is set and corresponds to an existing page.
  • Authentication errors: Verify that the API token credentials are correct and have sufficient permissions to update pages.
  • Invalid HTML content: If the HTML content is malformed, the API might reject the update. Validate HTML before sending.
  • Automatic mode parsing issues: When using automatic tool description mode, ambiguous or incomplete request descriptions may cause incorrect resource or operation selection. Use manual mode for precise control.
  • API endpoint errors: Check the base URL configuration and ensure the BookStack API is accessible.

Links and References

Discussion