Actions31
Overview
This node integrates with the BookStack API to export a specific chapter resource in various formats. It is useful when you want to programmatically retrieve and save chapters from your BookStack instance for offline reading, sharing, or further processing.
Typical use cases include:
- Exporting a chapter as a PDF to distribute as a report or documentation.
- Exporting a chapter as Markdown for integration with other markdown-based tools or repositories.
- Exporting as HTML or plain text for web publishing or text analysis.
For example, you can automate exporting a chapter after updates to keep an archive or send it via email.
Properties
| Name | Meaning |
|---|---|
| Export Format | The format to export the chapter in. Options: HTML, PDF, Markdown, Plain Text |
Output
The node outputs the exported chapter content in the selected format. The output JSON contains the raw data of the exported file (e.g., HTML markup, PDF binary data encoded appropriately, Markdown text, or plain text).
If the export format is a binary-compatible type like PDF, the node will provide the data as binary output suitable for saving or further processing.
Dependencies
- Requires access to a BookStack instance with API enabled.
- Needs an API authentication token credential configured in n8n with base URL and token details.
- The node uses HTTP GET requests to the BookStack API endpoint
/chapters/{id}/export/{format}.
Troubleshooting
- Invalid ID or Resource Not Found: If the chapter ID is incorrect or does not exist, the API will return an error. Verify the chapter ID input.
- Authentication Errors: Ensure the API token credentials are correctly set up and have sufficient permissions.
- Unsupported Export Format: Only the listed formats (HTML, PDF, Markdown, Plain Text) are supported. Using an unsupported format will cause errors.
- Network Issues: Connectivity problems to the BookStack server will prevent export. Check network and base URL configuration.