BookStack icon

BookStack

Manage BookStack resources
Join our community

Actions22

Overview

This node integrates with the BookStack platform to manage its resources programmatically. Specifically, for the Page - Update operation, it allows users to update an existing page's details such as its name, content (HTML or Markdown), associated book or chapter, and tags.

Typical use cases include:

  • Updating documentation pages in a knowledge base when content changes.
  • Modifying page metadata like tags or titles to improve organization.
  • Migrating or synchronizing page content from other systems into BookStack.

For example, you might update a page’s HTML content after editing it externally or change the page’s associated chapter to reorganize your documentation structure.

Properties

Name Meaning
Page ID The unique identifier of the page to update. Required to specify which page to modify.
Name New name/title of the page (up to 255 characters).
Book ID ID of the book this page belongs to. Used to associate the page with a specific book.
Chapter ID ID of the chapter this page belongs to. Used to associate the page with a specific chapter.
HTML Content The updated HTML content of the page. Either this or Markdown Content must be provided.
Markdown Content The updated Markdown content of the page. Either this or HTML Content must be provided.
Tags Comma-separated list of tags to assign to the page for categorization and filtering.

Output

The node outputs JSON data representing the updated page object returned by the BookStack API. This typically includes all page properties such as its ID, name, content, associated book/chapter IDs, tags (as arrays of objects with tag names), and metadata like creation and update timestamps.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests against the BookStack API.
  • The node uses HTTP methods (PUT) to communicate with the BookStack REST endpoints.
  • No additional external dependencies beyond the BookStack API and n8n credential setup.

Troubleshooting

  • Missing required fields: If neither book_id nor chapter_id is provided during page creation, or if both html and markdown content are missing, the node will throw an error indicating these requirements.
  • Invalid Page ID: Providing an incorrect or non-existent Page ID will result in an API error when attempting to update.
  • API authentication errors: Ensure the API key credential is valid and has sufficient permissions to update pages.
  • Malformed tags: Tags should be comma-separated strings; improper formatting may cause unexpected behavior.
  • Content conflicts: Updating both HTML and Markdown simultaneously may lead to content overwrites depending on BookStack’s handling.

To resolve errors, verify input parameters, ensure correct resource identifiers, and confirm API credentials.

Links and References

Discussion