BookStackInstall

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 resource with the Get operation, it retrieves a single page by its ID from the BookStack system.

Common scenarios where this node is beneficial include:

• Fetching detailed content of a specific page in a documentation or knowledge base.
• Automating retrieval of page data for further processing or display in other systems.
• Integrating BookStack page content into workflows that require dynamic access to documentation.

Practical example:

• You want to retrieve the content of a page with a known ID to display it on an external website or to analyze its HTML content programmatically.

Properties

Output

The node outputs JSON data representing the requested page resource as returned by the BookStack API. This typically includes all page details such as its ID, name, HTML content, associated book or chapter IDs, creation and update timestamps, and other metadata.

If the node supports binary data output (not indicated for the Get Page operation), it would represent file attachments or exports, but for this operation, only JSON output is expected.

Example output structure (simplified):

{
  "id": 123,
  "name": "Example Page",
  "html": "<h1>Example Page</h1><p>Content here...</p>",
  "book_id": 1,
  "chapter_id": null,
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T12:00:00Z",
  ...
}

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node expects the BookStack instance base URL and authentication tokens configured in n8n credentials.
• HTTP requests are made to the BookStack REST API endpoints.

Troubleshooting

• Missing or invalid ID: If the ID property is not provided or incorrect, the API call will fail. Ensure the correct page ID is supplied.
• Authentication errors: Verify that the API key/token credentials are correctly set up and have sufficient permissions.
• Resource not found: If the page ID does not exist, the API will return a 404 error. Confirm the ID corresponds to an existing page.
• Network issues: Check connectivity to the BookStack server and ensure the base URL is correct.
• Automatic detection failures: When using "Set Automatically" mode with a natural language description, ambiguous or unclear descriptions may lead to incorrect resource/operation detection. In such cases, switch to manual mode.

Links and References

• BookStack API Documentation
• BookStack Official Website