BookStack icon

BookStack

Manage BookStack resources
Join our community

Actions22

Overview

This node integrates with the BookStack platform, allowing users to manage various BookStack resources such as books, pages, shelves, and chapters. Specifically, for the Page - Get operation, it retrieves detailed information about a single page by its unique identifier. This is useful when you want to fetch content or metadata of a specific page within your BookStack instance.

Practical examples include:

  • Fetching a page's content to display or process it in another workflow.
  • Retrieving page metadata for reporting or auditing purposes.
  • Using the page data as input for further automation steps like notifications or backups.

Properties

Name Meaning
Page ID The unique identifier of the page to retrieve. Example: "456". This is a required field.

Output

The node outputs JSON data representing the requested page object from BookStack. The structure typically includes all page details such as name, content (HTML or markdown), associated book or chapter IDs, tags, and other metadata as provided by the BookStack API.

No binary data output is produced by this operation.

Example output JSON snippet (simplified):

{
  "id": 456,
  "name": "Sample Page",
  "html": "<p>Page content here</p>",
  "markdown": "Page content here",
  "book_id": 12,
  "chapter_id": null,
  "tags": [
    {"name": "tag1"},
    {"name": "tag2"}
  ]
}

Dependencies

  • Requires an active connection to a BookStack instance via an API key credential.
  • The node uses HTTP requests to communicate with the BookStack REST API endpoints.
  • Proper API credentials must be configured in n8n to authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or missing Page ID will cause the request to fail.
    • Network connectivity problems or incorrect API credentials will result in authentication errors.
    • If the specified page does not exist, the API will return an error indicating the resource was not found.

  • Error messages:

    • "Either book_id or chapter_id must be provided when creating a page" — Not applicable for Get operation but relevant for page creation.
    • API errors are caught and rethrown with descriptive messages; ensure the Page ID is correct and the API credentials have sufficient permissions.

  • Resolution tips:

    • Double-check the Page ID value.
    • Verify API credentials and endpoint URL configuration.
    • Confirm that the user associated with the API key has permission to read pages.

Links and References

Discussion