About this integration
Customer support help desk platform for managing tickets, live chat, contacts, and approval workflows. Use it from the workflow canvas with no custom glue script required.
This integration exposes 8 triggers, 61 search modules and 74 actions as workflow nodes. Authentication uses basic authentication.
How to connect
The credential form asks for Domain and API Key.
Prefer the interactive builder form? Open it on the app page.
Paste your credentials once — WEXTL® stores them encrypted and reuses the connection across every workflow that needs it.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
Connecting BoldDesk to WEXTL®
| Field | Type | Help |
|---|---|---|
DomainRequired | text | Enter your domain (e.g., yourcompany.bolddesk.com). |
API KeyRequired | password | Generate your API key in BoldDesk: Go to your profile → Personal Settings → API Keys tab → Create API Key, then paste it here. |
Use it in workflow automation
Start with Watch Activity, then add Activate Agent.
The canvas below runs Watch Activity into Activate Agent — watch the video, then drop a node onto the canvas.
Select the Watch Ticket trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Add Tags To Ticket as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 82 ready-made modules for support work — each run logs its inputs and outputs for debugging.
BoldDesk workflow on the canvas: Watch Ticket then Add Tags To Ticket
Triggers, searches and actions
Use the tables below to inspect BoldDesk's 8 triggers, 61 search modules, and 74 actions.
Triggers
8 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Activity
- Watch Activity Attachment
- Watch Activity Comments
- Watch Approval Requests
- Watch Conversations
Searches
Fetch data on demand using 61 search modules that query the app during a run.
- Get a Contact
- Get Activity Tags
- Get Agent By Email
- Get Agent By Group Id
- Get a Group
Actions
74 action modules cover the full range of create, update, and delete operations.
- Activate Agent
- Add Activity Attachment To An Activity
- Add Contact Groups to Contact
- Add Member To Group
- Add Tags To Ticket
Explore the fields available for each BoldDesk trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Activity ID | number |
Activity subject | text |
Activity description | text |
Created by | object |
Phone number | text |
Mobile number | text |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Created on | text |
Modified by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Modified on | date |
Activity status | object |
Status category | text |
Description | text |
Text color | text |
Background color | text |
ID | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Extension | text |
Content type | text |
Size | number |
Created on | date |
File URL | text |
Cloud storage type | text |
| Field | Type |
|---|---|
Comment ID | number |
Description | text |
Update flag name | text |
Update flag ID | number |
Source | text |
Created by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Modified by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Created on | date |
| Field | Type |
|---|---|
Approval ID | text |
Ticket ID | number |
Ticket title | text |
Ticket status | object |
Status ID | number |
Description | text |
Text color | text |
Background color | text |
ID | number |
Approval request ID | number |
Approval title | text |
Description | text |
Approval request status | object |
Status ID | number |
Description | text |
Text color | text |
Background color | text |
ID | number |
| Field | Type |
|---|---|
IP address | text |
Browser details | text |
City | text |
Country | text |
Custom details | text |
Agent | object |
Status | text |
Is ai agent | text |
ID | number |
Guid | text |
Name | text |
Display name | text |
Email | text |
Short code | text |
Color code | text |
Profile image URL | text |
Language | object |
ID | number |
Name | text |
Priority | object |
ID | number |
Name | text |
Background color | text |
Sort order | number |
| Field | Type |
|---|---|
Message ID | text |
Conversation ID | text |
Author | object |
User ID | number |
Visitor ID | text |
Is user | boolean |
From | text |
Is private | boolean |
Created on | date |
Message content | object |
Message | text |
Text format | text |
Attachments | text |
Catalog items | text |
Fields | text |
Form message ID | text |
Response fields | text |
| Field | Type |
|---|---|
Ticket ID | number |
Title | text |
Agent | object |
Name | text |
ID | number |
Group | object |
Name | text |
ID | number |
Category | object |
ID | number |
Name | text |
Status | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Priority | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Brand | text |
| Field | Type |
|---|---|
Is first update | boolean |
Is updated by customer | boolean |
ID | number |
Description | text |
Has attachment | boolean |
Attachments | array |
Created on | date |
Updated on | date |
Searches
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
User ID | number |
Contact display name | text |
Contact name | text |
Email ID | text |
Secondary email ID | text |
Status | text |
Last activity on | date |
Is verified | boolean |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Tag ID | number |
Name | text |
| Field | Type |
|---|---|
Email AddressRequired | text |
| Field | Type |
|---|---|
Is available | boolean |
Contact name | text |
Contact display name | text |
Contact phone no | text |
Contact tag | text |
Contact mobile no | text |
Contact address | text |
Contact job title | text |
| Field | Type |
|---|---|
Filter | text |
Include Total Count | boolean |
Order By | choice |
Group ID | choice |
Role | choice |
Shift ID | text |
Agent User ID | choice |
Limit | number |
| Field | Type |
|---|---|
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
| Field | Type |
|---|---|
Group name | text |
Group ID | number |
Group module ID | number |
Group module name | text |
Description | text |
Short code | text |
Color code | text |
Business hours | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Message ID | text |
Conversation ID | text |
Author | object |
User ID | number |
Visitor ID | text |
Is user | boolean |
From | text |
Is private | boolean |
Created on | text |
Message content | object |
Message | text |
Text format | text |
Attachments | text |
Catalog items | text |
Fields | text |
Form message ID | text |
Response fields | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Activity ID | number |
Activity subject | text |
Activity description | text |
Created by | object |
Phone number | text |
Mobile number | text |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Created on | text |
Modified by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Modified on | date |
Activity status | object |
Status category | text |
Description | text |
Text color | text |
Background color | text |
ID | number |
| Field | Type |
|---|---|
Agent User IDRequired | choice |
| Field | Type |
|---|---|
Is available | boolean |
Contact name | text |
Contact display name | text |
Contact phone no | text |
Contact tag | text |
Contact mobile no | text |
Contact address | text |
Contact job title | text |
| Field | Type |
|---|---|
Visitor IDRequired | choice |
| Field | Type |
|---|---|
Timezone | text |
Language | object |
ID | number |
Name | text |
Linked user | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Last conversation on | date |
Last modified on | date |
Originated from brand | object |
ID | number |
Name | text |
ID | text |
Name | text |
| Field | Type |
|---|---|
EmailRequired | choice |
| Field | Type |
|---|---|
User ID | number |
Contact display name | text |
Contact name | text |
Email ID | text |
Secondary email ID | text |
Status | text |
Last activity on | text |
Is verified | boolean |
| Field | Type |
|---|---|
Contact Field IDRequired | choice |
| Field | Type |
|---|---|
Can edit in agent portal | boolean |
Is mandatory for submitting form in agent portal | boolean |
Is visible in customer portal | boolean |
Can edit in customer portal | boolean |
Is mandatory for submitting form in customer portal | boolean |
Is visible on sign up | boolean |
Field group ID | number |
Field ID | number |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Agent | object |
ID | number |
Guid | text |
Name | text |
Display name | text |
Email | text |
Short code | text |
Color code | text |
Profile image URL | text |
Priority | object |
ID | number |
Name | text |
Last modified on | date |
Created on | date |
Status sort order | number |
Priority sort order | number |
Source sort order | number |
Language | object |
ID | number |
Name | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Short code | text |
Color code | text |
Display name | text |
Name | text |
Email ID | text |
User ID | number |
Is verified | boolean |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Tag ID | number |
Name | text |
| Field | Type |
|---|---|
Approval IDRequired | choice |
| Field | Type |
|---|---|
Ticket ID | number |
Ticket title | text |
Ticket status | object |
Status ID | number |
Description | text |
Text color | text |
Background color | text |
ID | number |
Approval request ID | number |
Title | text |
Description | text |
Status | object |
Status ID | number |
Description | text |
Text color | text |
Background color | text |
ID | number |
Type | object |
ID | number |
Name | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Ticket ID | number |
Title | text |
Agent | object |
Name | text |
ID | number |
Group | object |
Name | text |
ID | number |
Category | object |
ID | number |
Name | text |
Status | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Priority | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Brand | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Tag ID | number |
Name | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
EmailRequired |
| Field | Type |
|---|---|
User details | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | text |
Name | text |
Phone | text |
Address | text |
Time zone name | text |
Contact group | array |
Time zone iana name | text |
Mobile | text |
| Field | Type |
|---|---|
User IDRequired | text |
| Field | Type |
|---|---|
User details | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | text |
Name | text |
Phone | text |
Address | text |
Time zone name | text |
Contact group | array |
Time zone iana name | text |
Mobile | text |
| Field | Type |
|---|---|
Ticket ID | choice |
Statuses | array |
Status ID | number |
Types | array |
Type ID | number |
Search Text | text |
View ID | number |
User ID | choice |
Contact Group ID | choice |
Advanced Filters | text |
| Field | Type |
|---|---|
Activity ID | number |
Activity subject | text |
Activity description | text |
Created by | object |
Phone number | text |
Mobile number | text |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Created on | text |
Modified by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Modified on | date |
Activity status | object |
Status category | text |
Description | text |
Text color | text |
Background color | text |
ID | number |
| Field | Type |
|---|---|
Activity IDRequired | choice |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Extension | text |
Content type | text |
Size | number |
Created on | date |
File URL | text |
Cloud storage type | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Comment ID | number |
Description | text |
Update flag name | text |
Update flag ID | number |
Source | text |
Created by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Modified by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Created on | date |
| Field | Type |
|---|---|
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Color code | text |
Status category | object |
ID | number |
Name | text |
| Field | Type |
|---|---|
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Activity Type ID | number |
Name | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
| Field | Type |
|---|---|
Filter | text |
Search Type | choice |
Exclude Agent IDs | choice |
Exclude Group IDs | choice |
Include Agent IDs | choice |
Include Group IDs | choice |
Limit | number |
| Field | Type |
|---|---|
Agent ID | number |
Name | text |
Email ID | text |
Color code | text |
Short code | text |
Is agent | boolean |
Category name | text |
| Field | Type |
|---|---|
User Status | number |
Is Available | boolean |
Role | choice |
Verified Agents Only | boolean |
Agent Tags | text |
Copilot Assigned | boolean |
Advanced Filters | text |
Filter | text |
| Field | Type |
|---|---|
Is available | boolean |
Name | text |
Display name | text |
User ID | number |
Email ID | text |
Roles | array |
Status | text |
Last activity on | text |
| Field | Type |
|---|---|
Filter | text |
Order By | choice |
Include Total Count | boolean |
Only Customers | boolean |
Only Email Users | boolean |
Limit | number |
| Field | Type |
|---|---|
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
| Field | Type |
|---|---|
Ticket ID | number |
Statuses | array |
Status ID | number |
Types | array |
Type ID | number |
Advanced Filters | text |
View | choice |
Search Text | text |
Include Total Count | boolean |
Order By | choice |
| Field | Type |
|---|---|
Approval ID | text |
Ticket ID | number |
Ticket title | text |
Ticket status | object |
Status ID | number |
Description | text |
Text color | text |
Background color | text |
ID | number |
Approval request ID | number |
Approval title | text |
Description | text |
Approval request status | object |
Status ID | number |
Description | text |
Text color | text |
Background color | text |
ID | number |
| Field | Type |
|---|---|
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Approval request status list | array |
Total list count | number |
| Field | Type |
|---|---|
Search | text |
Limit | number |
| Field | Type |
|---|---|
Field ID | number |
API name | text |
Label for agent portal | text |
Label for customer portal | text |
Is default system field | boolean |
Is active | boolean |
Is visible in customer portal | boolean |
Field type | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Search | text |
Sort By | choice |
Include Total Count | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Access scope ID | number |
Is primary | boolean |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Order By | choice |
Include Total Count | boolean |
Limit | number |
| Field | Type |
|---|---|
Contact Note ID | number |
Subject | text |
Description | text |
Has attachment | boolean |
Created on | date |
Updated on | date |
Created by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Is edited | boolean |
| Field | Type |
|---|---|
Search | text |
Advanced Filters | text |
Sort By | choice |
Include Total Count | boolean |
View | text |
Limit | number |
| Field | Type |
|---|---|
Contact external reference ID | text |
Contact address | text |
Contact custom fields | object |
Cf contact custom name | text |
Cf contact additional info | text |
Cf contact custom checkbox | text |
Cf contact custom yesno | text |
Cf contact date | text |
Cf contact datetime | text |
Cf customer countries | text |
Cf contact secondary email | text |
Cf contact web link | text |
Cf customer region | text |
User ID | number |
Contact name | text |
Contact display name | text |
Email ID | text |
Is verified | boolean |
| Field | Type |
|---|---|
Filter | text |
Limit | number |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Date created | date |
| Field | Type |
|---|---|
Filter ID | text |
Fields | array |
Field | text |
Brand IDs | choice |
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
IP address | text |
Browser details | text |
City | text |
Country | text |
Custom details | text |
Agent | object |
Status | text |
Is ai agent | text |
ID | number |
Guid | text |
Name | text |
Display name | text |
Email | text |
Short code | text |
Color code | text |
Profile image URL | text |
Language | object |
ID | number |
Name | text |
Priority | object |
ID | number |
Name | text |
Background color | text |
Sort order | number |
| Field | Type |
|---|---|
Filter | text |
Exclusion IDs | array |
Status ID | number |
Status Category IDs | array |
Status Category ID | number |
Brand ID | choice |
Limit | number |
| Field | Type |
|---|---|
Status category | object |
ID | number |
Name | text |
Field option ID | number |
Sort order | number |
ID | number |
Name | text |
Background color | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Include Total Count | boolean |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Chat conversation guid | text |
Ticket details | object |
ID | number |
Title | text |
Status | object |
Is visible in customer portal | boolean |
Customer portal ticket URL | text |
Status | text |
Source | text |
Agent | text |
| Field | Type |
|---|---|
Include Total Count | boolean |
Order By | choice |
Last Ticket Changed From | date |
Last Ticket Changed To | date |
Brand IDs | choice |
Limit | number |
| Field | Type |
|---|---|
Ticket ID | number |
Title | text |
Category | object |
ID | number |
Name | text |
Created on | date |
Status | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Requested by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Last modified on | date |
Last ticket state changed on | date |
| Field | Type |
|---|---|
Group Module | choice |
Filter | text |
Include Total Count | boolean |
Order By | choice |
Include Additional Group IDs | text |
Limit | number |
| Field | Type |
|---|---|
Group name | text |
Group ID | number |
Group module ID | number |
Group module name | text |
| Field | Type |
|---|---|
Group Module | choice |
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Group name | text |
Group ID | number |
Group module ID | number |
Group module name | text |
Description | text |
Short code | text |
Color code | text |
Business hours | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
Filter | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Short code | text |
Color code | text |
Name | text |
Display name | text |
User ID | number |
Is agent | boolean |
Email ID | text |
Can participate in ticket auto assignment | boolean |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Include Total Count | boolean |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
Message ID | text |
Conversation ID | text |
Author | object |
User ID | number |
Visitor ID | text |
Is user | boolean |
From | text |
Is private | boolean |
Created on | date |
Message content | object |
Message | text |
Text format | text |
Attachments | text |
Catalog items | text |
Fields | text |
Form message ID | text |
Response fields | text |
| Field | Type |
|---|---|
Brand IDs | choice |
Include Total Count | boolean |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
Agent | object |
ID | number |
Guid | text |
Name | text |
Display name | text |
Email | text |
Short code | text |
Color code | text |
Profile image URL | text |
Priority | object |
ID | number |
Name | text |
Last modified on | date |
Created on | date |
Status sort order | number |
Priority sort order | number |
Source sort order | number |
Language | object |
ID | number |
Name | text |
| Field | Type |
|---|---|
Include Total Count | boolean |
Order By | choice |
Last Ticket Changed From | date |
Last Ticket Changed To | date |
Brand IDs | choice |
Limit | number |
| Field | Type |
|---|---|
Ticket ID | number |
Title | text |
Category | object |
ID | number |
Name | text |
Created on | text |
Status | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Requested by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Last modified on | date |
Last ticket state changed on | date |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Update ID | number |
Is file attached in private note | boolean |
ID | number |
Name | text |
Extension | text |
Content type | text |
Size | number |
Created on | date |
| Field | Type |
|---|---|
Filter | text |
Limit | number |
| Field | Type |
|---|---|
Field ID | number |
API name | text |
Label for agent portal | text |
Label for customer portal | text |
Is default system field | boolean |
Is active | boolean |
Is visible in customer portal | boolean |
Field type | text |
| Field | Type |
|---|---|
Brand IDRequired | choice |
Filter | text |
Include Total Count | boolean |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
Field ID | number |
API name | text |
Label for agent portal | text |
Label for customer portal | text |
Is default system field | boolean |
Is active | boolean |
Is visible in customer portal | boolean |
Field type | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Transaction ID | number |
Change logs | array |
Automation | object |
ID | number |
Name | text |
Automation type | text |
Automation type ID | number |
Is sla rule removed | boolean |
Updated on | text |
Updated by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | text |
Type | object |
Name | text |
Description | text |
Color code | text |
Macros | text |
Ai agent | object |
ID | number |
Name | text |
| Field | Type |
|---|---|
Advanced Filters | text |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Ticket metric ID | number |
Ticket ID | number |
Org ID | number |
Resolved on | text |
Resolution time | number |
Closure time | number |
Reopen count | number |
Assigned group count | number |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Include Total Count | boolean |
Order By | choice |
Message Tag IDs | array |
Message Tag ID | number |
Limit | number |
| Field | Type |
|---|---|
Notes type | text |
ID | number |
Description | text |
Has attachment | boolean |
Attachments | array |
Created on | date |
Updated on | date |
Updated by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
| Field | Type |
|---|---|
Filter | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
Advanced Filters | text |
Filter ID | text |
Fields | array |
Field | choice |
Brand IDs | choice |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Ticket ID | number |
Title | text |
Agent | object |
Name | text |
ID | number |
Group | object |
Name | text |
ID | number |
Category | object |
ID | number |
Name | text |
Status | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Priority | object |
Description | text |
Text color | text |
Background color | text |
ID | number |
Brand | text |
| Field | Type |
|---|---|
Filter | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
Filter | text |
Limit | number |
| Field | Type |
|---|---|
Ticket ID | number |
Name | text |
Color code | text |
Status category | object |
ID | number |
Name | text |
Field option ID | text |
| Field | Type |
|---|---|
Advanced Filters | text |
Include Total Count | boolean |
Order By | choice |
Include Deleted Updates | boolean |
Limit | number |
| Field | Type |
|---|---|
Is first update | boolean |
Is updated by customer | boolean |
Ticket update ID | number |
Ticket ID | number |
Description | text |
Created on | date |
Updated on | date |
Updated by | object |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | text |
Is phone no verified | boolean |
Phone no | text |
User ID | number |
Name | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Include Total Count | boolean |
Order By | choice |
Message Tag IDs | array |
Message Tag ID | number |
Include First Update | boolean |
Attachments Count | number |
Limit | number |
| Field | Type |
|---|---|
Is first update | boolean |
Is updated by customer | boolean |
ID | number |
Description | text |
Has attachment | boolean |
Attachments | array |
Created on | date |
Updated on | date |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Include Total Count | boolean |
Order By | choice |
Limit | number |
| Field | Type |
|---|---|
Worklog ID | number |
Time spent | number |
Is billable | boolean |
Worklog date | date |
Description | text |
Created by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
Created on | text |
Updated by | object |
Agent shift ID | number |
Agent shift name | text |
Ticket limit | number |
Chat limit | number |
Email ID | text |
Short code | text |
Color code | text |
Status | text |
Is verified | boolean |
Profile image URL | url |
| Field | Type |
|---|---|
User IDRequired | choice |
Filter | text |
Limit | number |
| Field | Type |
|---|---|
User ID | number |
Name | text |
Is primary | boolean |
| Field | Type |
|---|---|
Status ID | text |
Is Verified | boolean |
Source ID | text |
Country ID | text |
Filter | text |
Include Total Count | boolean |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
Visitor ID | text |
Name | text |
User name | text |
Email | |
Phone | text |
Country | text |
Division | text |
City | text |
Actions
| Field | Type |
|---|---|
Agent User IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
Upload FilesRequired | text |
| Field | Type |
|---|---|
Data | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Contact Groups | array |
| Field | Type |
|---|---|
Contact group ID | number |
Is success | boolean |
Reason | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
MembersRequired | array |
Member | object |
| Field | Type |
|---|---|
Result | object |
ID | number |
Is success | boolean |
Reason | text |
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
TagsRequired | array |
Tag | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Approval IDRequired | choice |
Comment | text |
Attachments | array |
Attachment Token | text |
Approval Reason ID | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Mark Tickets as Spam | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Approval IDRequired | choice |
Approver GUIDRequired | text |
Comment | text |
Attachments | array |
Attachment Token | text |
Approval Reason ID | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
User IDRequired | choice |
NameRequired | text |
Skip Validation | boolean |
Display Name | text |
Time Zone ID | choice |
All Brand Access | boolean |
Brand IDs | choice |
Role IDsRequired | choice |
| Field | Type |
|---|---|
Name | text |
Display name | text |
Time zone ID | number |
Has all brand access | boolean |
Brand ids | text |
Role ids | text |
Ticket access scope ID | number |
Agent phone no | text |
| Field | Type |
|---|---|
Contact NameRequired | text |
EmailRequired | choice |
Secondary Email | choice |
Display Name | text |
Phone Number | text |
Mobile Number | text |
Address | text |
Job Title | text |
| Field | Type |
|---|---|
Contact ID | number |
Message | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Subject | text |
DescriptionRequired | text |
Attachments | text |
| Field | Type |
|---|---|
Contact Note ID | number |
Message | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
DescriptionRequired | text |
Attachments | array |
Attachment Token | text |
Activity Status ID | number |
Mentioned User IDs | array |
Mentioned User ID | number |
| Field | Type |
|---|---|
Activity ID | number |
Message | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Group NameRequired | text |
Description | text |
Group ModuleRequired | choice |
Business Hour ID | choice |
| Field | Type |
|---|---|
Group ID | number |
Message | text |
Short code | text |
Color code | text |
| Field | Type |
|---|---|
Activity SubjectRequired | text |
Activity Description | text |
Activity TypeRequired | number |
Skip Dependency Validation | boolean |
Activity Priority | number |
Activity StatusRequired | number |
Activity Agent | number |
Linked Ticket | number |
| Field | Type |
|---|---|
Activity ID | number |
Message | text |
| Field | Type |
|---|---|
Upload FilesRequired | text |
| Field | Type |
|---|---|
Data | text |
| Field | Type |
|---|---|
EmailRequired | choice |
Agent Name | text |
Display Name | text |
Time Zone ID | choice |
Has All Brand Access | boolean |
Brand IDs | choice |
Role IDs | choice |
Ticket Access Scope ID | number |
| Field | Type |
|---|---|
Agent ID | number |
Message | text |
| Field | Type |
|---|---|
Ticket ID | choice |
SubjectRequired | text |
Description | text |
Approval Request Type IDRequired | number |
ApproversRequired | array |
User ID | choice |
Attachments | array |
Attachment Token | text |
Time Spent | number |
Is Billable | boolean |
| Field | Type |
|---|---|
Approval ID | number |
Message | text |
| Field | Type |
|---|---|
Attachment FileRequired | text |
| Field | Type |
|---|---|
Token | text |
URL | url |
| Field | Type |
|---|---|
Visitor IDRequired | choice |
Name | text |
Email Address | text |
Contact Group ID | choice |
Phone Number | text |
Send Email Notification | boolean |
| Field | Type |
|---|---|
ID | number |
Message | text |
| Field | Type |
|---|---|
Brand IDRequired | choice |
SubjectRequired | text |
Category ID | number |
Status ID | number |
Visible In Customer Portal | boolean |
Requester ID | text |
DescriptionRequired | text |
Agent ID | choice |
| Field | Type |
|---|---|
Ticket ID | number |
Is file upload success | boolean |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Note DescriptionRequired | text |
Public Note | boolean |
Attachments | array |
Attachment Token | text |
Mentioned Users | array |
User ID | number |
Last Update ID | number |
Last Refresh Date | date |
Time Spent | number |
| Field | Type |
|---|---|
Description | text |
At mentioned user ids | array |
Last update ID | number |
Last refresh date | text |
Time spent | text |
Message tags | text |
Updated byuser idor email ID | text |
Skip email notification | boolean |
| Field | Type |
|---|---|
FileRequired | text |
Conversation IDRequired | text |
Private Attachment | boolean |
Inline Attachment | boolean |
| Field | Type |
|---|---|
Token | text |
URL | url |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Approval IDRequired | choice |
ApproversRequired | array |
User ID | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Description | text |
Time Spent | number |
Is BillableRequired | boolean |
Time Log Date | date |
Time Log Type ID | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Agent User IDRequired | choice |
New Ticket Agent | choice |
New Ticket Group | choice |
Reassign Tickets or Chats | boolean |
Remove Agent Only | boolean |
Integration App ID | number |
New Chat Agent | choice |
New Chat Group | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Contact IDsRequired | choice |
Mark Tickets as Spam | boolean |
Integration App ID | number |
Modified User ID | number |
| Field | Type |
|---|---|
ID | number |
Is success | boolean |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Conversation IDRequired | text |
Message IDRequired | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Activity IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Approval IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Worklog IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Attachment IDRequired | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Contact Group IDsRequired | choice |
| Field | Type |
|---|---|
ID | number |
Is success | boolean |
Reason | text |
| Field | Type |
|---|---|
Note IDRequired | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Conversation IDRequired | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
User IDRequired | number |
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Visitor IDRequired | choice |
| Field | Type |
|---|---|
Is agent | boolean |
Message | text |
| Field | Type |
|---|---|
URLRequired | text |
DomainRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Block Contact | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Primary Contact IDRequired | number |
Secondary Contact IDsRequired | array |
| Field | Type |
|---|---|
Contact external reference ID | text |
Contact address | text |
Contact custom fields | object |
Cf contact custom name | text |
Cf contact additional info | text |
Cf contact custom checkbox | text |
Cf contact custom yesno | text |
Cf contact date | text |
Cf contact datetime | text |
Cf customer countries | text |
Cf contact secondary email | text |
Cf contact web link | text |
Cf customer region | text |
User ID | number |
Contact name | text |
Contact display name | text |
Email ID | text |
Is verified | boolean |
| Field | Type |
|---|---|
Visitor IDsRequired | choice |
| Field | Type |
|---|---|
Message | text |
Result | array |
| Field | Type |
|---|---|
Contact IDsRequired | choice |
Force Delete | boolean |
| Field | Type |
|---|---|
Contact ID | number |
Is success | boolean |
| Field | Type |
|---|---|
Approval IDRequired | choice |
Comment | text |
Attachments | array |
Attachment Token | text |
Approval Reason ID | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
TagsRequired | array |
Tag | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Unblock Contact | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Reply DescriptionRequired | text |
Attachments | array |
Attachment Token | text |
Mentioned Users | array |
User ID | number |
Last Update ID | number |
Last Refresh Date | date |
Time Spent | number |
Message Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | number |
Is file upload success | boolean |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Private Message | boolean |
User ID | choice |
Visitor ID | choice |
MessageRequired | text |
Text FormatRequired | choice |
Attachments | array |
Attachment | object |
| Field | Type |
|---|---|
Approval IDRequired | choice |
User IDsRequired | choice |
| Field | Type |
|---|---|
Result | array |
Message | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Send To Requester | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Remove Tickets from Spam | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Skip Validation | boolean |
Contact Name | text |
Email ID | choice |
Contact Display Name | text |
Time Zone ID | choice |
Language ID | choice |
Contact Notes | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Reason | text |
Skip Dependency Validation | boolean |
Assign Only If Null | boolean |
Category ID | number |
Status ID | number |
Priority ID | number |
Chat Agent ID | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Agent User IDRequired | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Agent User IDRequired | choice |
Skip Validation | boolean |
Integration App ID | number |
Modified User ID | number |
Contact Name | text |
Contact Display Name | text |
Email | choice |
Contact Tags | text |
| Field | Type |
|---|---|
Activity IDRequired | choice |
Skip Dependency Validation | boolean |
Activity SubjectRequired | text |
Activity StatusRequired | number |
Activity Priority | number |
Activity Agent | number |
Activity Description | text |
Activity Linked Ticket | number |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Agent User IDRequired | choice |
Agent Name | text |
Email | choice |
Display Name | text |
Time Zone ID | choice |
Has All Brand Access | boolean |
Brand IDs | choice |
Role IDs | choice |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Approval IDRequired | choice |
Subject | text |
Description | text |
Time Spent | number |
Is Billable | boolean |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Worklog IDRequired | choice |
Description | text |
Time Spent | number |
Is BillableRequired | boolean |
Worklog Date | date |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Note IDRequired | number |
Subject | text |
DescriptionRequired | text |
Attachments | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
Group NameRequired | text |
Description | text |
Business Hour ID | number |
| Field | Type |
|---|---|
Message | text |
Short code | text |
Color code | text |
| Field | Type |
|---|---|
Group IDRequired | choice |
Participate In Ticket Auto Assignment | boolean |
Participate In Chat Auto Assignment | boolean |
Skip Assignee Changes | boolean |
Group Owner | boolean |
New Agent ID | number |
New Group ID | number |
Reassign Group Or Agent | boolean |
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Ticket IDRequired | choice |
Skip Validation | boolean |
Category ID | number |
Type ID | number |
Status ID | number |
Priority ID | number |
Agent ID | choice |
Group ID | choice |
| Field | Type |
|---|---|
Is success | boolean |
Message | text |
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
Message | text |



