Carbone icon

Carbone

Node for the Carbone API

Actions5

Overview

The Carbone node for n8n enables interaction with the Carbone API, specifically to manage templates and reports. The Get Template operation retrieves a template file from Carbone by its ID and outputs it as binary data, making it useful for workflows that need to fetch and process document templates (e.g., DOCX, ODT) stored in Carbone.

Common scenarios:

  • Downloading a template for inspection or further processing.
  • Passing a template to another node for manipulation or conversion.
  • Archiving templates from Carbone into external storage systems.

Example use case:
A workflow downloads a DOCX template from Carbone, then sends it via email or stores it in Google Drive.

Properties

Name Type Meaning
ID String ID of resource to Get, Edit, Delete or add data to. For "Get Template", this is the template's unique identifier in Carbone.
Binary Property String Name of the binary property which will contain the downloaded template file. Default is data.

Output

  • json:
    • Contains the original input item's JSON data (if any).
  • binary:
    • A property named according to the value of Binary Property (default: data), containing the downloaded template file as binary data.
    • The binary data includes metadata such as filename ("Template") and MIME type.

Example output structure:

{
  "json": { /* original item data */ },
  "binary": {
    "data": {
      "data": "<base64-encoded file>",
      "fileName": "Template",
      "mimeType": "<detected mime type>"
    }
  }
}

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:

  • Invalid or missing ID: If the provided ID does not correspond to an existing template, the node may throw an error indicating the resource was not found.
  • Missing credentials: If the carboneApi credential is not set up, the node will fail to authenticate.
  • Binary property overwrite: If the specified binary property name already exists on the item, it will be overwritten.

Error messages:

  • "No binary data exists on item!": Not relevant for "Get Template" (applies to upload operations).
  • Errors from Carbone API (e.g., 404 Not Found): Ensure the ID is correct and the template exists.
  • "No binary data property ... does not exist on item!": Not applicable for this operation.

Resolution steps:

  • Double-check the template ID.
  • Verify Carbone API credentials are correctly configured in n8n.
  • Ensure the binary property name does not conflict with other properties you need.

Links and References

Discussion