BookStack icon

BookStack

Consume BookStack API
Join our community

Actions56

Overview

This node integrates with the BookStack API, specifically allowing users to manage "Chapter" resources among others. The "Get" operation for the Chapter resource retrieves detailed information about a specific chapter by its ID.

Common scenarios where this node is beneficial include:

  • Fetching metadata and content of a particular chapter within a book in BookStack.
  • Automating documentation workflows that require retrieving chapter details.
  • Integrating BookStack chapters into other systems or dashboards by pulling chapter data dynamically.

Practical example:

  • You want to retrieve the details of a chapter with a known ID to display it in an external application or to process its content further.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation. Options: "Set Automatically", "Set Manually".
Request Description (Shown if "Tool Description" is "Set Automatically") Describe your request in natural language; the system will try to infer the resource and operation automatically. Example: "Get chapter with ID 123".
ID The unique identifier of the chapter resource you want to get. Required for "get" operation.

Output

The output JSON contains the full response from the BookStack API for the requested chapter. This typically includes fields such as:

  • Chapter ID
  • Name/title of the chapter
  • Associated book ID
  • Description or summary
  • Creation and update timestamps
  • Any other metadata provided by the BookStack API for chapters

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 and authentication tokens to be configured in the credentials.
  • The BookStack API must be accessible from the environment where n8n runs.

Troubleshooting

  • Missing or invalid ID: If the "ID" property is not set or incorrect, the API call will fail. Ensure the correct chapter ID is provided.
  • Authentication errors: If the API key or token is missing or invalid, requests will be rejected. Verify credentials configuration.
  • Network issues: Connectivity problems to the BookStack server will cause failures. Check network access and base URL correctness.
  • Automatic detection inaccuracies: When using "Set Automatically" mode with a natural language description, the system may misinterpret the intended operation or resource. In such cases, switch to "Set Manually" and specify resource and operation explicitly.

Common error messages:

  • HTTP 404 Not Found: The chapter with the specified ID does not exist.
  • HTTP 401 Unauthorized: Authentication failed due to invalid or missing credentials.
  • Validation errors if required parameters are missing.

Links and References

Discussion