BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to update a Page resource. It allows users to modify existing pages by specifying the page ID and updating properties such as the page's name and its HTML content. This is useful for automating content management workflows, such as programmatically editing documentation or knowledge base pages stored in BookStack.

Practical examples include:

  • Automatically updating a page's content after generating new HTML from another system.
  • Renaming a page based on external triggers or data changes.
  • Integrating with CI/CD pipelines to keep documentation up-to-date.

Properties

Name Meaning
ID The unique identifier of the Page to update (required).
Name The new name/title of the Page (required).
HTML Content The updated HTML content of the Page, allowing rich text formatting and structure.

Output

The node outputs JSON data representing the updated Page resource as returned by the BookStack API. This typically includes fields such as the page ID, name, HTML content, and other metadata reflecting the current state of the page after the update.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
  • Network access to the BookStack API endpoint is necessary.

Troubleshooting

  • Missing or invalid ID: The update operation requires a valid Page ID. Ensure the ID provided corresponds to an existing page.
  • Authentication errors: If the API token or base URL is incorrect or missing, the request will fail. Verify credentials are correctly set.
  • Validation errors: The API may reject updates if required fields like "Name" are empty or if the HTML content is malformed.
  • API rate limits or connectivity issues: Network problems or API throttling can cause failures; check connectivity and API usage limits.

Links and References

Discussion