Overview
The Carbone node for n8n enables users to interact with the Carbone API, specifically to add new document templates. This is useful in scenarios where you need to upload and manage template files (such as DOCX or ODT) that will later be used for generating reports via Carbone's rendering engine.
Common use cases:
- Automating the upload of new report templates as part of a document generation workflow.
- Integrating dynamic template management into business processes (e.g., HR, invoicing, contracts).
- Enabling non-technical users to update templates through an n8n workflow rather than manual API calls.
Example:
A company wants to allow their HR team to update employment contract templates directly from Google Drive. An n8n workflow can fetch the file, then use this node to upload it to Carbone for future automated report generation.
Properties
| Name | Type | Meaning |
|---|---|---|
| ID | String | The unique identifier of the resource (template). Not required for Add Template operation. |
| Binary Property | String | The name of the binary property containing the file data to upload. For multipart uploads, you can specify multiple pairs in the format: "sendKey1:binaryProperty1,sendKey2:binaryProperty2". Default is "data". |
Output
- json: Contains the response from the Carbone API after uploading the template. Typically includes metadata about the uploaded template, such as its ID and status.
- binary: Not used for this operation (
Add Template). Only relevant for download operations.
Example output (json):
{
"success": true,
"data": {
"templateId": "abc123",
"message": "Template uploaded successfully"
}
}
Dependencies
- External Service: Requires access to the Carbone API.
- API Key: You must configure Carbone API credentials in n8n under the name
carboneApi. - n8n Configuration: The input item must contain a binary property (default:
data) with the file to upload.
Troubleshooting
Common Issues:
No binary data exists on item!
Cause: The input item does not have a binary property with the specified name.
Solution: Ensure the previous node provides a file in the correct binary property.No binary data property "X" does not exist on item!
Cause: The specified binary property name does not match any property in the input item.
Solution: Double-check the property name and ensure the file is attached correctly.Invalid API credentials or network errors
Cause: Incorrect Carbone API key or connectivity issues.
Solution: Verify your API credentials and network access to Carbone.