BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API, allowing users to manage BookStack resources such as pages, books, chapters, shelves, users, roles, attachments, and tags. Specifically for the Page - Get operation, it retrieves detailed information about a single page by its ID.

Common scenarios where this node is beneficial include:

  • Fetching content or metadata of a specific page in a BookStack documentation system.
  • Automating retrieval of page details for use in workflows like content synchronization, reporting, or further processing.
  • Integrating BookStack page data into other systems or dashboards.

Example: You want to get the details of a page with ID 123 to display its content in another application or to verify its existence before updating it.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown if "Set Automatically" is chosen) Describe your request in natural language, e.g., "Get page 123"
ID The unique identifier of the page to retrieve. Required for operations: get, update, delete

Output

The output contains a JSON object representing the retrieved page resource from the BookStack API. This includes all standard fields returned by the API for a page, such as its ID, name, HTML content, associated book or chapter IDs, creation and update timestamps, and other metadata.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "API Documentation",
  "html": "<h1>API Documentation</h1><p>Content here...</p>",
  "book_id": 10,
  "chapter_id": 5,
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T15:30:00Z",
  ...
}

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The base URL of the BookStack instance must be configured in the credentials.
  • The node uses HTTP requests with token-based authentication to communicate with the BookStack REST API.

Troubleshooting

  • Missing or invalid ID: If the ID property is empty or incorrect, the API will return an error indicating the resource was not found. Ensure the correct page ID is provided.
  • Authentication errors: If the API key or base URL is misconfigured, the node will fail to authenticate. Verify that the API token and URL are correctly set in the credentials.
  • Network issues: Connectivity problems to the BookStack server will cause request failures. Check network access and server availability.
  • Automatic mode parsing errors: When using "Set Automatically," ambiguous or unclear request descriptions may lead to incorrect resource or operation detection. Use clear, concise descriptions or switch to manual mode.

Links and References

Discussion