Requirements
Karbon requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]
Get your Karbon credentials
- Bearer TokenpasswordRequired
The Authorization token (a 36-character GUID) for your API Application. Find it in Karbon UI -> Settings -> Connected Apps -> API Applications -> your application.
[1] - Access KeypasswordRequired
The AccessKey, a JWT starting with eyJ..., issued with the token from the same API Application. Find it in Karbon UI -> Settings -> Connected Apps -> API Applications -> your application.
[1]
Connect Karbon in WEXTL
- Log in to your WEXTL account, add the Karbon 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 Karbon 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 →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Karbon node modules
The list below is a reference of every Karbon node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Karbon node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch ContactsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Contact Key | text |
| Full Name | text |
| Preferred Name | text |
| Salutation | text |
| Client Owner | text |
| Client Manager | text |
| Address | text |
| Email Address | text |
| Phone Number | text |
| Role Or Title | text |
| Contact Type | text |
| User Defined Identifier | text |
| Last Modified Date Time | date |
Watch EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Resource Key | text |
| Resource Type | text |
| Action Type | text |
| Timestamp | date |
Watch FilesTrigger
Output fields[3]
| Field | Type |
|---|---|
| File Context Key | text |
| Source | text |
| File Name | text |
| File Size | number |
| Mime Type | text |
| Download URL | url |
| Date Created | date |
| Is Archived | boolean |
| Is Shared | boolean |
Watch Individual Time EntriesTrigger
Output fields[3]
| Field | Type |
|---|---|
| Individual Time Entry Key | text |
| Timesheet Key | text |
| Entity Key | text |
| Work Item Key | text |
| Client Key | text |
| Client Type | text |
| User Key | text |
| Role Name | text |
| Task Type Name | text |
| Task Type Is Billable | boolean |
| Date | date |
| Minutes | number |
| Description | text |
| Hourly Rate | number |
| Total Cost | number |
4other output fields
Watch Integration TasksTrigger
Output fields[3]
| Field | Type |
|---|---|
| Created At | text |
| Task Definition Key | text |
| Task Key | text |
| Locale | text |
| Work Item Key | text |
| Work Item Client Key | text |
| Work Type | text |
| Task Name | text |
| Task Primary Link URL | text |
| Task Primary Link Label | text |
| Task Secondary Link URL | text |
| Task Secondary Link Label | text |
| Task Status | text |
| Primary Status | text |
| Task Due Date | text |
1other output field
Watch InvoicesTrigger
Output fields[3]
| Field | Type |
|---|---|
| Invoice Key | text |
| Invoice Number | text |
| Total Amount Due | number |
| Invoice Total | number |
| Invoice Sub Total | number |
| Invoice Tax Total | number |
| Invoice Date | date |
| Payment Due Date | date |
| Updated At | date |
| Currency Code | text |
| Payment Instructions | text |
| Invoice Status | text |
| Client | object |
| Client Key | text |
| Client Type | text |
| Name | text |
| Address Line | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country | text |
| Email Address | text |
| Tax Line Items | array |
| Tax Line Items | text |
Watch OrganizationsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Organization Key | text |
| Full Name | text |
| Phone Number | text |
| Email Address | text |
| Website | text |
| Contact Type | text |
| Last Modified Date Time | date |
| User Defined Identifier | text |
Watch Work TemplatesTrigger
Output fields[3]
| Field | Type |
|---|---|
| Work Template Key | text |
| Title | text |
| Description | text |
| Work Type Key | text |
| Has Scheduled Client Task Groups | boolean |
| Estimated Budget | text |
| Estimated Time | text |
| Draft Has Changes | boolean |
| Published Date | date |
| Number Of Work Items Created | number |
| Date Last Work Item Created | date |
| Date Modified | date |
| Actor Roles | array |
| Actor Key | text |
| Actor Name | text |
Get a Business CardAction
Input fields[3]
| Field | Type |
|---|---|
Business Card KeyRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Entity Type | text |
| Entity Key | text |
| Business Card Key | text |
| Is Primary Card | boolean |
| Web Sites | array |
| Web Sites | text |
| Email Addresses | array |
| Email Addresses | text |
| Organization Key | text |
| Role Or Title | text |
| Facebook Link | text |
| Linked In Link | text |
| Twitter Link | text |
| Skype Link | text |
| Addresses | array |
| Address Key | text |
| Address Lines | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country Code | text |
| Label | text |
| Phone Numbers | array |
| Phone Number Key | text |
| Number | text |
| Country Code | text |
| Label | text |
Get a Client GroupAction
Input fields[3]
| Field | Type |
|---|---|
Client Group KeyRequired | choice |
| Expand | text |
Output fields[3]
| Field | Type |
|---|---|
| Client Group Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Primary Contact | text |
| Last Modified Date Time | date |
| Members | array |
| Contact Key | text |
| Organization Key | text |
| Entity Description | object |
| Text | text |
| Accounting Details | text |
| Business Card | object |
| Business Card Key | text |
| Entity Type | text |
| Entity Key | text |
| Is Primary Card | boolean |
| Web Sites | array |
| Email Addresses | array |
| Organization Key | text |
| Role Or Title | text |
| Facebook Link | text |
| Linked In Link | text |
| Client Team | array |
| Member Key | text |
| Member Type | text |
| Role Type | text |
Get a Client Group by User Defined IdentifierAction
Input fields[3]
| Field | Type |
|---|---|
User Defined IdentifierRequired | text |
| Expand | choice |
Output fields[3]
| Field | Type |
|---|---|
| Client Group Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Primary Contact | text |
| Last Modified Date Time | date |
| Members | array |
| Contact Key | text |
| Organization Key | text |
| Entity Description | object |
| Text | text |
| Accounting Details | text |
| Business Card | object |
| Business Card Key | text |
| Entity Type | text |
| Entity Key | text |
| Is Primary Card | boolean |
| Web Sites | array |
| Email Addresses | array |
| Organization Key | text |
| Role Or Title | text |
| Facebook Link | text |
| Linked In Link | text |
| Client Team | array |
| Member Key | text |
| Member Type | text |
| Role Type | text |
Get a CommentAction
Get a ContactAction
Input fields[3]
| Field | Type |
|---|---|
Contact KeyRequired | choice |
| Expand | choice |
Output fields[3]
| Field | Type |
|---|---|
| Contact Key | text |
| First Name | text |
| Middle Name | text |
| Last Name | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Avatar URL | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
4other output fields
Get a Contact by User Defined IdentifierAction
Input fields[3]
| Field | Type |
|---|---|
User Defined IdentifierRequired | text |
| Expand | choice |
Output fields[3]
| Field | Type |
|---|---|
| Contact Key | text |
| First Name | text |
| Middle Name | text |
| Last Name | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Avatar URL | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
4other output fields
Get a NoteAction
Get a PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Payment KeyRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Payment Key | text |
| Payment Reference | text |
| Payment Type | text |
| Payment Date | date |
| Gross Amount | number |
| Payment Method | text |
| Client Key | text |
| Karbon Payment | object |
| Card Type | text |
| Card Country | text |
| Card Funding | text |
| Payout Status | text |
| Surcharge Amount | number |
| Surcharge Tax Amount | number |
| Karbon Fee Amount | number |
| Karbon Fee Tax Amount | number |
| Net Amount | number |
| Client | object |
| Client Key | text |
| Client Type | text |
| Name | text |
| Address Line | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country | text |
| Email Address | text |
Get a TeamAction
Get a TimesheetAction
Input fields[3]
| Field | Type |
|---|---|
Timesheet KeyRequired | choice |
| Expand | choice |
Output fields[3]
| Field | Type |
|---|---|
| Timesheet Key | text |
| Start Date | date |
| End Date | date |
| User Key | text |
| Status | text |
| Work Item Keys | array |
| Work Item Keys | text |
| Time Entries | array |
| Time Entry Key | text |
| Entity Key | text |
| Work Item Key | text |
| Client Key | text |
| Client Type | text |
| Role Name | text |
| Task Type Name | text |
| Minutes | number |
| Hourly Rate | number |
| Descriptions | array |
Get a UserAction
Get a Work ItemAction
Input fields[3]
| Field | Type |
|---|---|
Work Item KeyRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Work Item Key | text |
| Assignee Email Address | text |
| Assignee Key | text |
| Assignee Name | text |
| Title | text |
| Client Key | text |
| Client Name | text |
| Client Type | text |
| Client User Defined Identifier | text |
| Related Client Group Key | text |
| Client Group Key | text |
| Related Client Group Name | text |
| Start Date | date |
| Due Date | date |
| Deadline Date | date |
14other output fields
Get a Work ScheduleAction
Input fields[3]
| Field | Type |
|---|---|
Work Schedule KeyRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Work Schedule Key | text |
| Client Key | text |
| Client Type | text |
| Created From Work Item Key | text |
| Recurrence Frequency | text |
| Custom Frequency Units | text |
| Custom Frequency Multiple | number |
| Frequency Description | text |
| Schedule Start Date | date |
| Schedule End Date | date |
| Schedule Due Date Method | text |
| Schedule Due Date Days | number |
| Schedule Due Date Month Multiple | number |
| Schedule Deadline Date Method | text |
| Schedule Deadline Date Days | number |
10other output fields
Get a Work TemplateAction
Input fields[3]
| Field | Type |
|---|---|
Work Template KeyRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Work Template Key | text |
| Title | text |
| Description | text |
| Work Type Key | text |
| Has Scheduled Client Task Groups | boolean |
| Estimated Budget | text |
| Estimated Time | text |
| Draft Has Changes | boolean |
| Published Date | date |
| Number Of Work Items Created | number |
| Date Last Work Item Created | date |
| Date Modified | date |
| Actor Roles | array |
| Actor Key | text |
| Actor Name | text |
Get an Estimate SummaryAction
Get an Individual Time EntryAction
Input fields[3]
| Field | Type |
|---|---|
Individual Time Entry KeyRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Individual Time Entry Key | text |
| Timesheet Key | text |
| Entity Key | text |
| Work Item Key | text |
| Client Key | text |
| Client Type | text |
| User Key | text |
| Role Name | text |
| Task Type Name | text |
| Task Type Is Billable | boolean |
| Date | date |
| Minutes | number |
| Description | text |
| Hourly Rate | number |
| Total Cost | number |
4other output fields
Get an Integration TaskAction
Input fields[3]
| Field | Type |
|---|---|
Integration Task KeyRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Created At | text |
| Task Definition Key | text |
| Task Key | text |
| Locale | text |
| Work Item Key | text |
| Work Item Client Key | text |
| Work Type | text |
| Task Name | text |
| Task Primary Link URL | text |
| Task Primary Link Label | text |
| Task Secondary Link URL | text |
| Task Secondary Link Label | text |
| Task Status | text |
| Primary Status | text |
| Task Due Date | text |
1other output field
Get an InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice KeyRequired | choice |
| Expand | choice |
Output fields[3]
| Field | Type |
|---|---|
| Invoice Key | text |
| Invoice Number | text |
| Total Amount Due | number |
| Invoice Total | number |
| Invoice Sub Total | number |
| Invoice Tax Total | number |
| Invoice Date | text |
| Payment Due Date | text |
| Updated At | text |
| Currency Code | text |
| Payment Instructions | text |
| Invoice Status | text |
| Client | object |
| Client Key | text |
| Client Type | text |
| Name | text |
| Address Line | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country | text |
| Email Address | text |
| Tax Line Items | array |
| Tax Line Items | text |
| Line Items | array |
| Line Item Key | text |
| Billable Item Entity Key | text |
| Billable Item Type | text |
| Description | text |
| Quantity | number |
| Unit Price | text |
| Amount | number |
| Tax Rate | number |
| Tax Rate Name | text |
4other output fields
Get an OrganizationAction
Input fields[3]
| Field | Type |
|---|---|
Organization KeyRequired | choice |
| Expand | text |
Output fields[3]
| Field | Type |
|---|---|
| Organization Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | text |
| Sex | text |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
| Business Cards | array |
| Business Card Key | text |
| Entity Type | text |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | text |
| Linked In Link | text |
| Contacts | array |
| Contact Key | text |
| Full Name | text |
| Preferred Name | text |
| Salutation | text |
| Client Owner | text |
| Client Manager | text |
| Address | text |
| Email Address | text |
| Phone Number | text |
| Role Or Title | text |
| Client Team | array |
| Member Key | text |
| Member Type | text |
| Role Type | text |
Get an Organization by User Defined IdentifierAction
Input fields[3]
| Field | Type |
|---|---|
User Defined IdentifierRequired | text |
| Expand | choice |
Output fields[3]
| Field | Type |
|---|---|
| Organization Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | text |
| Sex | text |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
| Business Cards | array |
| Business Card Key | text |
| Entity Type | text |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | text |
| Linked In Link | text |
Get Custom Field ValuesAction
Get File DetailsAction
Get Tenant SettingsAction
Output fields[3]
| Field | Type |
|---|---|
| Contact Types | array |
| Name | text |
| Contact Type Key | text |
| Tenant Key | text |
| Client Access Activated | boolean |
| Work Statuses | array |
| Name | text |
| Type | text |
| Children | array |
| Work Types | array |
| Name | text |
| Work Type Key | text |
| Available Statuses | object |
| Service Types | array |
| Name | text |
| Service Type Key | text |
| Work Type Keys | array |
List Client GroupsSearch
List ContactsSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Contact Key | text |
| Full Name | text |
| Preferred Name | text |
| Salutation | text |
| Client Owner | text |
| Client Manager | text |
| Address | text |
| Email Address | text |
| Phone Number | text |
| Role Or Title | text |
| Contact Type | text |
| User Defined Identifier | text |
| Last Modified Date Time | date |
List Custom Field DefinitionsSearch
List Estimate SummariesSearch
List FilesSearch
List Individual Time EntriesSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Individual Time Entry Key | text |
| Timesheet Key | text |
| Entity Key | text |
| Work Item Key | text |
| Client Key | text |
| Client Type | text |
| User Key | text |
| Role Name | text |
| Task Type Name | text |
| Task Type Is Billable | boolean |
| Date | date |
| Minutes | number |
| Description | text |
| Hourly Rate | number |
| Total Cost | number |
4other output fields
List Integration Task DefinitionsSearch
List Integration TasksSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Created At | text |
| Task Definition Key | text |
| Task Key | text |
| Locale | text |
| Work Item Key | text |
| Work Item Client Key | text |
| Work Type | text |
| Task Name | text |
| Task Primary Link URL | text |
| Task Primary Link Label | text |
| Task Secondary Link URL | text |
| Task Secondary Link Label | text |
| Task Status | text |
| Primary Status | text |
| Task Due Date | text |
1other output field
List InvoicesSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Invoice Key | text |
| Invoice Number | text |
| Total Amount Due | number |
| Invoice Total | number |
| Invoice Sub Total | number |
| Invoice Tax Total | number |
| Invoice Date | text |
| Payment Due Date | text |
| Updated At | text |
| Currency Code | text |
| Payment Instructions | text |
| Invoice Status | text |
| Client | object |
| Client Key | text |
| Client Type | text |
| Name | text |
| Address Line | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country | text |
| Email Address | text |
| Tax Line Items | array |
| Tax Line Items | text |
List OrganizationsSearch
List PaymentsSearch
Input fields[3]
| Field | Type |
|---|---|
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Payment Key | text |
| Payment Reference | text |
| Payment Type | text |
| Payment Date | date |
| Gross Amount | number |
| Payment Method | text |
| Client Key | text |
| Karbon Payment | object |
| Card Type | text |
| Card Country | text |
| Card Funding | text |
| Payout Status | text |
| Surcharge Amount | number |
| Surcharge Tax Amount | number |
| Karbon Fee Amount | number |
| Karbon Fee Tax Amount | number |
| Net Amount | number |
| Client | object |
| Client Key | text |
| Client Type | text |
| Name | text |
| Address Line | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country | text |
| Email Address | text |
List RolesSearch
List TeamsSearch
List TimesheetsSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | choice |
| Expand | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Timesheet Key | text |
| Start Date | date |
| End Date | date |
| User Key | text |
| Status | text |
| Work Item Keys | array |
| Work Item Keys | text |
| Time Entries | array |
| Time Entry Key | text |
| Entity Key | text |
| Work Item Key | text |
| Client Key | text |
| Client Type | text |
| Role Name | text |
| Task Type Name | text |
| Minutes | number |
| Hourly Rate | number |
| Descriptions | array |
List UsersSearch
List Work ItemsSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Work Item Key | text |
| Assignee Email Address | text |
| Assignee Key | text |
| Assignee Name | text |
| Title | text |
| Client Key | text |
| Client Name | text |
| Client Type | text |
| Client User Defined Identifier | text |
| Related Client Group Key | text |
| Client Group Key | text |
| Related Client Group Name | text |
| Start Date | date |
| Due Date | date |
| Deadline Date | date |
10other output fields
List Work TemplatesSearch
Input fields[3]
| Field | Type |
|---|---|
| Filter | text |
| Orderby | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Work Template Key | text |
| Title | text |
| Description | text |
| Work Type Key | text |
| Has Scheduled Client Task Groups | boolean |
| Estimated Budget | text |
| Estimated Time | text |
| Draft Has Changes | boolean |
| Published Date | date |
| Number Of Work Items Created | number |
| Date Last Work Item Created | date |
| Date Modified | date |
| Actor Roles | array |
| Actor Key | text |
| Actor Name | text |
Add Team MembersAction
Input fields[3]
| Field | Type |
|---|---|
Team KeyRequired | choice |
User KeysRequired | array |
| User Keys | choice |
Create a Client GroupAction
Input fields[3]
| Field | Type |
|---|---|
Full NameRequired | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | choice |
| Primary Contact | text |
| Entity Description | object |
| Text | text |
| Members | array |
| Contact Key | text |
| Organization Key | text |
| Accounting Details | text |
| Business Card | object |
| Business Card Key | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Web Sites | array |
| Email Addresses | array |
| Organization Key | text |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
| Client Team | array |
| Member Key | text |
| Member Type | choice |
| Role Type | choice |
Output fields[3]
| Field | Type |
|---|---|
| Client Group Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Primary Contact | text |
| Last Modified Date Time | date |
| Members | array |
| Contact Key | text |
| Organization Key | text |
| Entity Description | object |
| Text | text |
| Accounting Details | text |
| Business Card | object |
| Business Card Key | text |
| Entity Type | text |
| Entity Key | text |
| Is Primary Card | boolean |
| Web Sites | array |
| Email Addresses | array |
| Organization Key | text |
| Role Or Title | text |
| Facebook Link | text |
| Linked In Link | text |
| Client Team | array |
| Member Key | text |
| Member Type | text |
| Role Type | text |
Create a ContactAction
Input fields[3]
| Field | Type |
|---|---|
First NameRequired | text |
| Middle Name | text |
Last NameRequired | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
| Restriction Level | choice |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Business Cards | array |
| Business Card Key | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
| Entity Description | object |
| Text | text |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | choice |
| Sex | choice |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
| Client Team | array |
| Member Key | text |
| Member Type | choice |
| Role Type | choice |
Output fields[3]
| Field | Type |
|---|---|
| Contact Key | text |
| First Name | text |
| Middle Name | text |
| Last Name | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Avatar URL | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
4other output fields
Create a Custom Field DefinitionAction
Create a Manual PaymentAction
Create a NoteAction
Input fields[3]
| Field | Type |
|---|---|
SubjectRequired | text |
BodyRequired | text |
Author Email AddressRequired | |
| Assignee Email Address | |
| Due Date | date |
| Todo Date | date |
| Timelines | array |
| Entity Type | choice |
| Entity Key | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Subject | text |
| Body | text |
| Author Email Address | text |
| Assignee Email Address | text |
| Due Date | date |
| Todo Date | date |
| Timelines | array |
| Entity Type | text |
| Entity Key | text |
| Comments | array |
| Comment Key | text |
| Comment Body | text |
| Created Date | date |
| Author Email Address | text |
Create a UserAction
Create a Work ItemAction
Input fields[3]
| Field | Type |
|---|---|
Assignee Email AddressRequired | |
TitleRequired | text |
Client KeyRequired | text |
Client TypeRequired | choice |
| Related Client Group Key | choice |
Start DateRequired | date |
| Due Date | date |
| Deadline Date | date |
| Work Type | text |
| Work Status | text |
| Primary Status | choice |
| Secondary Status | text |
| Work Template Key | choice |
| Work Schedule Key | text |
| Estimated Budget | number |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| Work Item Key | text |
| Assignee Email Address | text |
| Assignee Key | text |
| Assignee Name | text |
| Title | text |
| Client Key | text |
| Client Name | text |
| Client Type | text |
| Client User Defined Identifier | text |
| Related Client Group Key | text |
| Client Group Key | text |
| Related Client Group Name | text |
| Start Date | date |
| Due Date | date |
| Deadline Date | date |
13other output fields
Create a Work ScheduleAction
Input fields[3]
| Field | Type |
|---|---|
| Assignee User Key | choice |
Created From Work Item KeyRequired | choice |
Recurrence FrequencyRequired | choice |
| Custom Frequency Units | choice |
Custom Frequency MultipleRequired | number |
Schedule Start DateRequired | date |
| Schedule End Date | date |
Schedule Due Date MethodRequired | choice |
| Schedule Due Date Days | number |
| Schedule Due Date Month Multiple | number |
| Schedule Deadline Date Method | choice |
| Schedule Deadline Date Days | number |
| Schedule Deadline Date Month Multiple | number |
Prevent Start End On WeekendRequired | boolean |
| Initialize Before Start Date Units | choice |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| Work Schedule Key | text |
| Client Key | text |
| Client Type | text |
| Created From Work Item Key | text |
| Recurrence Frequency | text |
| Custom Frequency Units | text |
| Custom Frequency Multiple | number |
| Frequency Description | text |
| Schedule Start Date | date |
| Schedule End Date | date |
| Schedule Due Date Method | text |
| Schedule Due Date Days | number |
| Schedule Due Date Month Multiple | number |
| Schedule Deadline Date Method | text |
| Schedule Deadline Date Days | number |
10other output fields
Create an ExpenseAction
Input fields[3]
| Field | Type |
|---|---|
TimelineRequired | object |
| Entity Type | choice |
| Entity Key | text |
Expense DateRequired | date |
ValueRequired | number |
Billable ValueRequired | number |
DescriptionRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Expense Key | text |
| Timeline | object |
| Entity Type | text |
| Entity Key | text |
| Expense Date | date |
| Value | number |
| Billable Value | number |
| Description | text |
Create an OrganizationAction
Input fields[3]
| Field | Type |
|---|---|
Full NameRequired | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | choice |
| Business Cards | array |
| Business Card Key | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
| Entity Description | object |
| Text | text |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | choice |
| Sex | choice |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
| Client Team | array |
| Member Key | text |
| Member Type | choice |
| Role Type | choice |
Output fields[3]
| Field | Type |
|---|---|
| Organization Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | text |
| Sex | text |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
Delete a Custom Field DefinitionAction
Input fields[3]
| Field | Type |
|---|---|
Custom Field Definition KeyRequired | choice |
Delete a Manual PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Manual Payment KeyRequired | choice |
Download a FileAction
Make an API Calluniversal
Remove a Team MemberAction
Input fields[3]
| Field | Type |
|---|---|
Team KeyRequired | choice |
User KeyRequired | choice |
Reverse a Manual PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Payment KeyRequired | choice |
Reversal DateRequired | date |
Update a Business CardAction
Input fields[3]
| Field | Type |
|---|---|
Business Card KeyRequired | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | choice |
| Web Sites | array |
| Web Sites | text |
| Email Addresses | array |
| Email Addresses | text |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
| Twitter Link | url |
| Skype Link | url |
| Addresses | array |
| Address Lines | text |
| City | text |
| State Province County | text |
| Zip Code | text |
| Country Code | text |
| Label | choice |
| Phone Numbers | array |
| Number | text |
| Country Code | text |
| Label | choice |
Update a Client Group (Full)Action
Input fields[3]
| Field | Type |
|---|---|
Client Group KeyRequired | choice |
Full NameRequired | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | choice |
| Primary Contact | text |
| Entity Description | object |
| Text | text |
| Members | array |
| Contact Key | text |
| Organization Key | text |
| Business Card | object |
| Business Card Key | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
Update a Client Group (Partial)Action
Input fields[3]
| Field | Type |
|---|---|
Client Group KeyRequired | choice |
| Full Name | text |
Update a Contact (Full)Action
Input fields[3]
| Field | Type |
|---|---|
Contact KeyRequired | choice |
First NameRequired | text |
| Middle Name | text |
Last NameRequired | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
| Restriction Level | choice |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Business Cards | array |
| Business Card Key | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
| Entity Description | object |
| Text | text |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | choice |
| Sex | choice |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
1other input field
Update a Contact (Partial)Action
Input fields[3]
| Field | Type |
|---|---|
Contact KeyRequired | choice |
| First Name | text |
| Middle Name | text |
| Last Name | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
Output fields[3]
| Field | Type |
|---|---|
| Contact Key | text |
| First Name | text |
| Middle Name | text |
| Last Name | text |
| Preferred Name | text |
| Salutation | text |
| Suffix | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Avatar URL | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
1other output field
Update a Work Item (Full)Action
Input fields[3]
| Field | Type |
|---|---|
Work Item KeyRequired | choice |
Assignee Email AddressRequired | |
TitleRequired | text |
Client KeyRequired | text |
Client TypeRequired | choice |
| Related Client Group Key | choice |
Start DateRequired | date |
| Due Date | date |
| Deadline Date | date |
| Work Type | text |
| Work Status | text |
| Primary Status | choice |
| Secondary Status | text |
| Work Template Key | choice |
| Work Schedule Key | text |
5other input fields
Update a Work Item (Partial)Action
Input fields[3]
| Field | Type |
|---|---|
Work Item KeyRequired | choice |
Update a Work Schedule (Full)Action
Input fields[3]
| Field | Type |
|---|---|
Work Schedule KeyRequired | text |
Work Schedule KeyRequired | text |
| Assignee User Key | choice |
Created From Work Item KeyRequired | choice |
Recurrence FrequencyRequired | choice |
| Custom Frequency Units | choice |
Custom Frequency MultipleRequired | number |
Schedule Start DateRequired | date |
| Schedule End Date | date |
Schedule Due Date MethodRequired | choice |
| Schedule Due Date Days | number |
| Schedule Due Date Month Multiple | number |
| Schedule Deadline Date Method | choice |
| Schedule Deadline Date Days | number |
| Schedule Deadline Date Month Multiple | number |
6other input fields
Update a Work Schedule (Partial)Action
Input fields[3]
| Field | Type |
|---|---|
Work Schedule KeyRequired | text |
| Schedule End Date | text |
| Assignee User Key | choice |
Update an Estimate SummaryAction
Input fields[3]
| Field | Type |
|---|---|
Work Item IDRequired | choice |
| Estimate Minutes | number |
| Estimate Amount | number |
| Hourly Rate | number |
Update an Integration TaskAction
Input fields[3]
| Field | Type |
|---|---|
Integration Task KeyRequired | choice |
| Task Name | text |
| Task Primary Link URL | url |
| Task Primary Link Label | text |
| Task Secondary Link URL | url |
| Task Secondary Link Label | text |
| Task Status | text |
| Primary Status | choice |
| Task Due Date | text |
| Task Data | array |
| Task Data Key | text |
| Value | text |
Update an Organization (Full)Action
Input fields[3]
| Field | Type |
|---|---|
Organization KeyRequired | choice |
Full NameRequired | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | choice |
| Accounting Detail | object |
| Contact Perma Key | text |
| Organization Perma Key | text |
| Birth Date | date |
| Death Date | date |
| Salutation | choice |
| Sex | choice |
| Financial Year End Day | number |
| Financial Year End Month | number |
| Incorporation Date | date |
| Incorporation State | text |
| Business Cards | array |
| Business Card Key | text |
| Entity Type | choice |
| Entity Key | text |
| Is Primary Card | boolean |
| Organization Key | text |
| Web Sites | array |
| Email Addresses | array |
| Role Or Title | text |
| Facebook Link | url |
| Linked In Link | url |
| Entity Description | object |
| Text | text |
| Client Team | array |
| Member Key | text |
| Member Type | choice |
| Role Type | choice |
Update an Organization (Partial)Action
Input fields[3]
| Field | Type |
|---|---|
Organization KeyRequired | choice |
| Full Name | text |
| Prefer | text |
Output fields[3]
| Field | Type |
|---|---|
| Organization Key | text |
| Full Name | text |
| Client Owner | text |
| Client Manager | text |
| Contact Type | text |
| User Defined Identifier | text |
| Restriction Level | text |
| Last Modified Date Time | date |
| Entity Description | object |
| Text | text |
| Accounting Detail | text |
Update Custom Field ValuesAction
Input fields[3]
| Field | Type |
|---|---|
Entity KeyRequired | text |
| Custom Field Values | array |
| Custom Field Values Key | text |
| Name | text |
| Type | choice |
| Value | array |
Templates
Look for Karbon templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Arcsite[2]Mobile CAD and estimating for contractors — draw plans, takeoffs, and proposals on site.
- BlueFolderField service management software for work orders, technicians, customers, and service history.
- Autotask PSAManages tickets, projects, time entries, resources, and customer relationships for Autotask PSA users.
- ActiveCollabProject management for tasks, collaboration, and team workloads.
- AspireField service management for landscaping — estimating, scheduling, production, and billing.
References
- WEXTL® Karbon Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Karbon.
- WEXTL® visual workflow builder data.
Last updated: Oct 18, 2026 14:31