Carbone integration guide
VerifiedHow to connect Carbone to WEXTL and use its 2 triggers and 14 actions in your workflows. About Carbone: Generate PDFs and other documents from templates and data, and convert files between formats.
- 2 triggers
- 6 searches
- 8 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation6 min read
This documentation is compiled from our integration source code, internal specs for Carbone, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Carbone credentials
- API KeypasswordRequired
Copy the key from the home page of your account. A test key makes free watermarked PDFs only. A production key makes any format and uses credits. For a self-hosted Carbone with authentication turned off, enter any text.[1]
- API URLurl
Leave empty for Carbone Cloud (https://api.carbone.io). For a self-hosted server enter its address, for example https://carbone.example.com, without a slash at the end. The address must be reachable from the internet.[1]
Connect Carbone in WEXTL
- Log in to your WEXTL account, add the Carbone node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Carbone account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Carbone triggers and actions on WEXTL
The list below is a reference of every Carbone node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Carbone node module below. Each one opens to show its input parameters, outputs, and connection requirements.
Watch New Templates
TriggerScheduled check for added templates.
| Field | Type |
|---|---|
| Limit | number |
| Category | choice |
| Field | Type |
|---|---|
| ID | text |
| Version ID | text |
| Deployed At | number |
| Created At | number |
| Expire At | number |
| Size | number |
| Type | text |
| Name | text |
| Category | text |
| Comment | text |
| Tags | array |
| Origin | number |
Watch Rendered Documents
TriggerInstant trigger for finished renders.
| Field | Type |
|---|---|
| Success | boolean |
| Render ID | text |
| Error | text |
Download a Generated Document
SearchRendered file from Carbone.
| Field | Type |
|---|---|
Render IDRequired | text |
| File Name | text |
| Download as Attachment | boolean |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Download a Template
SearchTemplate source file for later steps.
| Field | Type |
|---|---|
TemplateRequired | choice |
| File Name | text |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Get the API Status
SearchService health and version.
| Field | Type |
|---|---|
| Success | boolean |
| Code | number |
| Message | text |
| Version | text |
List Template Categories
SearchTemplate groupings you can filter by.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Name | text |
List Template Tags
SearchLabels applied to templates.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Name | text |
List Templates
SearchStored document templates with their versions.
| Field | Type |
|---|---|
LimitRequired | number |
| Template ID | text |
| Version ID | text |
| Category | choice |
| Origin | choice |
| Search Text | text |
| Include Versions | boolean |
| Field | Type |
|---|---|
| ID | text |
| Version ID | text |
| Deployed At | number |
| Created At | number |
| Expire At | number |
| Size | number |
| Type | text |
| Name | text |
| Category | text |
| Comment | text |
| Tags | array |
| Origin | number |
Convert a Base64 Document
ActionDocument conversion from encoded content.
| Field | Type |
|---|---|
| Base64 File | text |
| Source Text | text |
Output FormatRequired | choice |
| PDF Password | secret |
| Watermark Text | text |
| Format Options (JSON) | text |
| Data | text |
| Converter | text |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Convert a Document
ActionFormat conversion of an uploaded file.
| Field | Type |
|---|---|
FileRequired | text |
| File Name | text |
Output FormatRequired | choice |
| PDF Password | secret |
| Watermark Text | text |
| Format Options (JSON) | text |
| Data | text |
| Converter | text |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Delete a Template
ActionTemplate or version removal.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| ID | text |
Generate a Document
ActionTemplate rendering with your data.
| Field | Type |
|---|---|
TemplateRequired | choice |
DataRequired | text |
Output FormatRequired | choice |
| PDF Password | secret |
| Watermark Text | text |
| Format Options (JSON) | text |
| Converter | text |
| Timezone | text |
| Language | text |
| Document Name | text |
| Complement (JSON) | text |
| Enumerations (JSON) | text |
| Translations (JSON) | text |
| Currency Source | text |
| Currency Target | text |
| Currency Rates (JSON) | text |
| Refresh Pagination | boolean |
| Fail On | choice |
| Batch Split By | text |
| Batch Output | choice |
3other input fields
| Field | Type |
|---|---|
| Success | boolean |
| Data | object |
| Render ID | text |
Generate and Download a Document
ActionSingle-call document generation delivered as a file.
| Field | Type |
|---|---|
TemplateRequired | choice |
DataRequired | text |
Output FormatRequired | choice |
| PDF Password | secret |
| Watermark Text | text |
| Format Options (JSON) | text |
| Converter | text |
| Timezone | text |
| Language | text |
| Document Name | text |
| Complement (JSON) | text |
| Enumerations (JSON) | text |
| Translations (JSON) | text |
| Currency Source | text |
| Currency Target | text |
| Currency Rates (JSON) | text |
| Refresh Pagination | boolean |
| Fail On | choice |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Make an API Call
universalFree-form Carbone REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
Update Template Metadata
ActionTemplate details and lifecycle dates.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Name | text |
| Comment | text |
| Category | choice |
| Tags | text |
| Delete At | date |
| Cancel Scheduled Deletion | boolean |
| Deploy Now | boolean |
| Deploy At | date |
| New Template ID | text |
| Field | Type |
|---|---|
| Success | boolean |
Upload a Template
ActionAdds a template file.
| Field | Type |
|---|---|
Template FileRequired | text |
| File Name | text |
| Name | text |
| Comment | text |
| Category | choice |
| Tags | text |
| Versioning | boolean |
| Existing Template ID | text |
| Deploy Now | boolean |
| Deploy At | date |
| Delete At | date |
| Sample (JSON) | text |
| Field | Type |
|---|---|
| ID | text |
| Version ID | text |
| Type | text |
| Size | number |
| Created At | number |
| Deployed At | number |
Templates
Look for Carbone templates in the WEXTL template library.
Browse templates →Other productivity integrations on WEXTL
Beeminder[2]Track goals, log datapoints, and manage pledges on Beeminder.
DocuSealSend, sign, and manage documents with DocuSeal e-signatures.
GoodyBusiness gifting: browse products, price and send gifts to recipients, track orders, and react to gift openings and deliveries.
DocupilotDocument automation with templates, e-signatures and bulk generation.
CraftMyPDFTemplate-based PDF and image generation.
References
- WEXTL® Carbone Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Carbone.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.





























