Overview
This node integrates with the Carbone API to generate reports based on predefined templates and input data. It allows users to create or select templates, generate reports in various formats, check report generation status, and download completed reports.
A common use case is automating document creation workflows where dynamic data needs to be merged into templates to produce PDFs, DOCX files, spreadsheets, presentations, or HTML reports. For example, generating invoices, certificates, or sales reports from JSON data using a stored template.
Properties
| Name | Meaning |
|---|---|
| Template ID | The identifier of the template to use for generating the report. |
| Data | JSON-formatted data that will be merged into the template to generate the report content. |
| Output Format | The format of the generated report file. Options: PDF, DOCX, XLSX, PPTX, HTML. |
Output
The node outputs JSON data representing the response from the Carbone API after each operation. For the "Generate Report" operation, this typically includes metadata about the generated report such as its ID and status.
When downloading a report, the node outputs binary data containing the actual report file (e.g., PDF). This binary data is attached under a binary property with the filename formatted as report-<reportId>.pdf. Alongside the binary data, a JSON object with the report ID and success status is also output.
Dependencies
- Requires an API key credential for authenticating with the Carbone API.
- Needs network access to the Carbone API endpoint specified in the credentials.
- The node expects the Carbone API URL and API key to be configured in n8n credentials.
Troubleshooting
- Common issues:
- Invalid or missing API key can cause authentication failures.
- Incorrect template ID or data format may result in errors during report generation.
- Network connectivity problems can prevent communication with the Carbone API.
- Error messages:
- Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
- Template not found errors suggest the provided template ID does not exist; confirm the template ID.
- JSON parsing errors mean the input data is malformed; ensure valid JSON is provided.
- To resolve errors, check credentials, validate input parameters, and ensure the Carbone API service is reachable.