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 "Chapter" resource and the "Get" operation, it retrieves detailed information about a single chapter by its unique identifier. This is useful when you want to fetch metadata or content of a specific chapter within a book in BookStack.

Practical examples include:

  • Automatically retrieving chapter details to display in another system.
  • Using chapter data to generate reports or summaries.
  • Syncing chapter information with external databases or CMS platforms.

Properties

Name Meaning
Chapter ID The unique identifier of the chapter to retrieve (e.g., 101). This is required to specify which chapter's details to fetch.

Output

The output is a JSON object representing the retrieved chapter's data from BookStack. It typically includes fields such as the chapter's name, description, associated book ID, tags, and other metadata as provided by the BookStack API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 101,
  "name": "Chapter Title",
  "description": "Description of the chapter",
  "book_id": 12,
  "tags": [
    {"name": "tag1"},
    {"name": "tag2"}
  ],
  ...
}

Dependencies

  • Requires an active connection to a BookStack instance via an API key credential configured in n8n.
  • The node uses HTTP requests to communicate with the BookStack REST API endpoints.
  • Proper permissions on the BookStack API are necessary to read chapter data.

Troubleshooting

  • Missing or invalid Chapter ID: Ensure that the "Chapter ID" property is set and corresponds to an existing chapter in BookStack.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network issues: Confirm that the BookStack server URL is reachable from the n8n environment.
  • API rate limits or server errors: If the BookStack API returns errors, check server logs and API usage limits.

Common error messages:

  • "Chapter not found": The specified Chapter ID does not exist.
  • "Unauthorized" or "Forbidden": Authentication failed or insufficient permissions.
  • "Request timed out": Network connectivity problems.

Resolving these usually involves verifying input parameters, credentials, and network access.

Links and References

Discussion