Skip to docs navigation

Carbone integration guide

Verified

How 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].

Open Carbone on WEXTL →
  • Carbone
  • WEXTL
  • Beeminder
  • DocuSeal
  • Goody
  • Docupilot
  • CraftMyPDF
  • BoldSign
  • Grist
  • codeREADr
  • Agiled (Public API)
  • ChMeetings
  • Outline
  • Formstack Documents
  • eSignatures.com
  • Nextcloud
  • Aboard Sign
  • ONLYOFFICE Docs
  • Mem
  • Dailybot
  • KoBoToolbox
  • Paperless-ngx
  • Grain
  • Form.io
  • Feathery
  • Egnyte
  • Frame.io V4
  • Adobe Acrobat Sign
  • DocuSign
  • Interact
  • Mural
  • 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]

  1. 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Carbone account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch New Templates

TriggerScheduled check for added templates.
Input fields[3]
FieldType
Limitnumber
Categorychoice
Output fields[3]
FieldType
IDtext
Version IDtext
Deployed Atnumber
Created Atnumber
Expire Atnumber
Sizenumber
Typetext
Nametext
Categorytext
Commenttext
Tagsarray
Originnumber

Watch Rendered Documents

TriggerInstant trigger for finished renders.
Output fields[3]
FieldType
Successboolean
Render IDtext
Errortext

Download a Generated Document

SearchRendered file from Carbone.
Input fields[3]
FieldType
Render IDRequired
text
File Nametext
Download as Attachmentboolean
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Download a Template

SearchTemplate source file for later steps.
Input fields[3]
FieldType
TemplateRequired
choice
File Nametext
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Get the API Status

SearchService health and version.
Output fields[3]
FieldType
Successboolean
Codenumber
Messagetext
Versiontext

List Template Categories

SearchTemplate groupings you can filter by.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Nametext

List Template Tags

SearchLabels applied to templates.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Nametext

List Templates

SearchStored document templates with their versions.
Input fields[3]
FieldType
LimitRequired
number
Template IDtext
Version IDtext
Categorychoice
Originchoice
Search Texttext
Include Versionsboolean
Output fields[3]
FieldType
IDtext
Version IDtext
Deployed Atnumber
Created Atnumber
Expire Atnumber
Sizenumber
Typetext
Nametext
Categorytext
Commenttext
Tagsarray
Originnumber

Convert a Base64 Document

ActionDocument conversion from encoded content.
Input fields[3]
FieldType
Base64 Filetext
Source Texttext
Output FormatRequired
choice
PDF Passwordsecret
Watermark Texttext
Format Options (JSON)text
Datatext
Convertertext
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Convert a Document

ActionFormat conversion of an uploaded file.
Input fields[3]
FieldType
FileRequired
text
File Nametext
Output FormatRequired
choice
PDF Passwordsecret
Watermark Texttext
Format Options (JSON)text
Datatext
Convertertext
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Delete a Template

ActionTemplate or version removal.
Input fields[3]
FieldType
TemplateRequired
choice
Output fields[3]
FieldType
Successboolean
IDtext

Generate a Document

ActionTemplate rendering with your data.
Input fields[3]
FieldType
TemplateRequired
choice
DataRequired
text
Output FormatRequired
choice
PDF Passwordsecret
Watermark Texttext
Format Options (JSON)text
Convertertext
Timezonetext
Languagetext
Document Nametext
Complement (JSON)text
Enumerations (JSON)text
Translations (JSON)text
Currency Sourcetext
Currency Targettext
Currency Rates (JSON)text
Refresh Paginationboolean
Fail Onchoice
Batch Split Bytext
Batch Outputchoice

3other input fields

Output fields[3]
FieldType
Successboolean
Dataobject
Render IDtext

Generate and Download a Document

ActionSingle-call document generation delivered as a file.
Input fields[3]
FieldType
TemplateRequired
choice
DataRequired
text
Output FormatRequired
choice
PDF Passwordsecret
Watermark Texttext
Format Options (JSON)text
Convertertext
Timezonetext
Languagetext
Document Nametext
Complement (JSON)text
Enumerations (JSON)text
Translations (JSON)text
Currency Sourcetext
Currency Targettext
Currency Rates (JSON)text
Refresh Paginationboolean
Fail Onchoice
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Make an API Call

universalFree-form Carbone REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext

Update Template Metadata

ActionTemplate details and lifecycle dates.
Input fields[3]
FieldType
TemplateRequired
choice
Nametext
Commenttext
Categorychoice
Tagstext
Delete Atdate
Cancel Scheduled Deletionboolean
Deploy Nowboolean
Deploy Atdate
New Template IDtext
Output fields[3]
FieldType
Successboolean

Upload a Template

ActionAdds a template file.
Input fields[3]
FieldType
Template FileRequired
text
File Nametext
Nametext
Commenttext
Categorychoice
Tagstext
Versioningboolean
Existing Template IDtext
Deploy Nowboolean
Deploy Atdate
Delete Atdate
Sample (JSON)text
Output fields[3]
FieldType
IDtext
Version IDtext
Typetext
Sizenumber
Created Atnumber
Deployed Atnumber

Look for Carbone templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Carbone Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Carbone.
  4. 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.