Actions31
Overview
This node integrates with the BookStack API to manage and export content from BookStack resources such as Books, Pages, and Chapters. Specifically, the Export operation for the Book resource allows users to export a book's content in various formats like HTML, PDF, Markdown, or Plain Text.
Typical use cases include:
- Exporting a complete book for offline reading or archival.
- Converting book content into different formats for publishing or sharing.
- Automating backups of book content in preferred formats.
For example, a user might export a book as a PDF to distribute a formatted version to team members or export as Markdown to integrate with documentation workflows.
Properties
| Name | Meaning |
|---|---|
| Export Format | The format to export the book in. Options: HTML, PDF, Markdown, Plain Text |
Output
The node outputs the exported content of the book in the selected format. The json output field will contain the raw data returned by the BookStack API for the export request, which typically is the file content or a link to the exported file depending on the API response.
If the export format is a binary file type (e.g., PDF), the node may output binary data representing the exported file, suitable for saving or further processing.
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 GET requests to fetch the exported content from the BookStack API endpoint.
Troubleshooting
- Invalid ID or Resource Not Found: Ensure the book ID provided exists and is accessible with the given API credentials.
- Authentication Errors: Verify that the API token and secret are correctly set in the credentials.
- Unsupported Export Format: Confirm that the export format is one of the supported options (HTML, PDF, Markdown, Plain Text).
- Network Issues: Check connectivity to the BookStack server and that the base URL is correct.
- Large Exports Timing Out: For very large books, exports might take longer; consider exporting smaller sections or checking API rate limits.