Carbone Lifecycle icon

Carbone Lifecycle

Interact with Carbone API through lifecycle stages

Actions4

Overview

The node interacts with the Carbone API to manage report lifecycle stages, including creating templates, generating reports from templates and data, checking report generation status, and downloading generated reports. It is useful in scenarios where automated document generation is needed, such as generating invoices, contracts, or personalized reports based on dynamic data.

For example, a user can upload a custom DOCX template, generate a PDF report by merging it with JSON data, check if the report is ready, and then download the final report file—all within an n8n workflow.

Properties

Name Meaning
Report ID ID of the report to check or download. Required for "Get Report Status" and "Download Report" operations.

(Note: Only properties relevant to the "Download Report" operation and "Default" resource are listed here.)

Output

  • The node outputs JSON data containing at least the reportId and a success flag indicating the download was successful.
  • Additionally, it outputs the downloaded report file as binary data under the key "data" in the binary property.
  • The binary file is named using the pattern report-<ReportID>.pdf.
  • This allows subsequent nodes to use or save the downloaded report file directly.

Dependencies

  • Requires an API key credential to authenticate with the Carbone API.
  • Needs network access to the Carbone API endpoint specified in the credentials.
  • No other external dependencies are required.

Troubleshooting

  • Common issues:

    • Invalid or expired API key will cause authentication failures.
    • Providing an incorrect or non-existent Report ID will result in errors when checking status or downloading.
    • Network connectivity problems may prevent communication with the Carbone API.

  • Error messages:

    • Errors thrown by the node include the message from the API response or request failure.
    • If the node is set to continue on fail, errors for individual items are returned in the output JSON under an error field.

  • Resolutions:

    • Verify that the API key credential is valid and has necessary permissions.
    • Confirm the Report ID is correct and that the report generation process has completed successfully before attempting to download.
    • Check network settings and firewall rules to ensure access to the Carbone API.

Links and References

Discussion