Carbone icon

Carbone

Node for the Carbone API
Join our community

Actions5

Overview

The Carbone node for n8n enables users to interact with the Carbone API, specifically to download a rendered report using its ID. This operation is useful when you have previously rendered a report (such as a PDF or document) via Carbone and want to retrieve the generated file for further processing, storage, or distribution within your workflow.

Common scenarios:

  • Automating the retrieval of dynamically generated reports (e.g., invoices, certificates).
  • Integrating Carbone-generated documents into email workflows.
  • Archiving or post-processing reports after generation.

Example:
After rendering an invoice report in Carbone, use this node to download the resulting PDF and send it as an email attachment.

Properties

Name Type Meaning
ID String The unique identifier of the rendered report you wish to download.
Binary Property String The name of the binary property under which the downloaded file will be stored in the output item.

Output

  • json:
    • Contains any JSON data from the input item. No new fields are added by this operation.
  • binary:
    • The downloaded report file is attached under the property name specified by "Binary Property".
    • The binary data represents the actual content of the rendered report (e.g., PDF, DOCX).

Example output structure:

{
  "json": { /* original input json */ },
  "binary": {
    "data": {
      "data": "<Buffer ...>",
      "fileName": "Report",
      "mimeType": "application/pdf"
    }
  }
}

(If "Binary Property" is set to "data")

Dependencies

  • External Service: Requires access to the Carbone API.
  • Credentials: Needs a configured carboneApi credential in n8n.
  • Environment: No special environment variables required beyond n8n's standard configuration.

Troubleshooting

Common Issues:

  • Missing or Invalid ID: If the provided ID does not correspond to an existing rendered report, the node may throw an error indicating that the resource was not found.
  • Binary Property Conflicts: If the specified binary property name already exists on the item, it will be overwritten.
  • No Binary Data: If the Carbone API fails to return the file, the binary property may be missing or empty.

Error Messages & Resolutions:

  • "No binary data property \"...\" does not exists on item!": Ensure the correct binary property name is specified and that the report has been successfully rendered before attempting to download.
  • API Authentication Errors: Make sure the carboneApi credentials are correctly set up in n8n.

Links and References

Discussion