About this integration
Cloud help desk for tickets, contacts, knowledge base, and automations. Use it from the workflow canvas with no custom glue script required.
This integration exposes 4 triggers, 70 search modules and 76 actions as workflow nodes. Authentication uses basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Domain and API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
DomainRequired | text | Your subdomain only — no |
API KeyRequired | password | Freshdesk → Profile Settings → View API Key. Treat it like a password. |
Use it in workflow automation
Start with Watch Companies, then add Add Ticket Watcher.
Triggers, searches and actions
Use the tables below to inspect Freshdesk's 4 triggers, 70 search modules, and 76 actions.
Triggers
4 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Companies
- Watch Contacts
- Watch Events
- Watch Tickets
Searches
Fetch data on demand using 70 search modules that query the app during a run.
- Get Account
- Get Admin Group
- Get Agent
- Get Agent Availability
- Get Article
Actions
76 action modules cover the full range of create, update, and delete operations.
- Add Ticket Watcher
- Bulk Delete Tickets
- Bulk Remove Ticket Watcher
- Bulk Update Tickets
- Cancel Companies Import
Explore the fields available for each Freshdesk trigger, search, and action.
Triggers
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
View All Tickets | boolean |
Deleted | boolean |
No fields documented.
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Description (Plain Text) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
Searches
| Field | Type |
|---|---|
ID | number |
Name | text |
Helpdesk Name | text |
Domains | array |
Domain | text |
Subscription Plan | text |
Created At | date |
| Field | Type |
|---|---|
Group IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Business Hour ID | number |
Escalate To | text |
Unassigned For | number |
Auto Ticket Assign | boolean |
Created At | date |
| Field | Type |
|---|---|
AgentRequired | choice |
| Field | Type |
|---|---|
ID | number |
Available | boolean |
Occasional | boolean |
Signature | text |
Ticket Scope | number |
Type | text |
Available Since | date |
Focus Mode | boolean |
| Field | Type |
|---|---|
AgentRequired | choice |
| Field | Type |
|---|---|
Available | boolean |
Available Since | date |
| Field | Type |
|---|---|
Article IDRequired | text |
| Field | Type |
|---|---|
ID | number |
Type | text |
Category ID | number |
Folder ID | number |
Hierarchy | array |
Level | number |
Type | text |
ID | number |
Name | text |
Title | text |
Description | text |
Status | number |
| Field | Type |
|---|---|
Automation TypeRequired | choice |
Automation Rule IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Performer | object |
Events | array |
Conditions | object |
| Field | Type |
|---|---|
Business Hour IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Is Default | boolean |
Time Zone | text |
Business Hours | object |
Monday | object |
Tuesday | object |
Wednesday | object |
Thursday | object |
Friday | object |
Saturday | object |
Sunday | object |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Response IDRequired | text |
| Field | Type |
|---|---|
ID | number |
Title | text |
Folder ID | number |
Content (Plain Text) | text |
Content (HTML) | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Canned Responses | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Title | text |
Folder ID | number |
Content (Plain Text) | text |
Content (HTML) | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
MessageRequired | text |
| Field | Type |
|---|---|
ID | text |
Thread ID | text |
Body (HTML) | text |
Body (Plain Text) | text |
Created By | text |
Edited | boolean |
Source | number |
Attachment IDs | array |
| Field | Type |
|---|---|
ThreadRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Title | text |
Created By | text |
Parent | object |
ID | text |
Type | text |
Anchor | object |
ID | text |
Type | text |
Participants | object |
Emails | array |
Agents | array |
Linked Object | object |
ID | text |
Type | text |
Attributes | object |
Links | object |
| Field | Type |
|---|---|
Export IDRequired | text |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
Import IDRequired | text |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
Company IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
| Field | Type |
|---|---|
Field IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Type | text |
Position | number |
Default | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
View All Tickets | boolean |
Deleted | boolean |
| Field | Type |
|---|---|
Field IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Label For Customers | text |
Type | text |
Position | number |
Default | text |
Editable In Signup | boolean |
| Field | Type |
|---|---|
Export IDRequired | text |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
Import IDRequired | text |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
ID | number |
Available | boolean |
Occasional | boolean |
Signature | text |
Ticket Scope | number |
Type | text |
Available Since | date |
Focus Mode | boolean |
| Field | Type |
|---|---|
Email Config IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
To Email | text |
Reply Email | text |
Active | boolean |
Group ID | number |
Product ID | number |
Created At | date |
| Field | Type |
|---|---|
GroupRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Business Hour ID | number |
Escalate To | number |
Unassigned For | number |
Auto Ticket Assign | boolean |
Created At | date |
| Field | Type |
|---|---|
MailboxRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Support Email | |
Group ID | number |
Product ID | number |
Default Reply Email | boolean |
Mailbox Type | text |
Created At | date |
| Field | Type |
|---|---|
MessageRequired | text |
| Field | Type |
|---|---|
Message ID | text |
From | object |
Channel Identifier | text |
To | object |
Recipient Identifier | text |
Channel Type | text |
External Reference ID | text |
Message | object |
Type | text |
Template | object |
Note Policy | object |
On Reply | object |
Ticket Properties | object |
Tags | array |
Custom Fields | object |
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
RoleRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Default | boolean |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Category IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
TicketRequired | choice |
Include | choice |
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Description (Plain Text) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
| Field | Type |
|---|---|
TicketRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Body (HTML) | text |
Body (Plain Text) | text |
Ticket ID | number |
User ID | number |
Incoming | boolean |
Private | boolean |
Support Email | text |
| Field | Type |
|---|---|
Ticket FormRequired | choice |
| Field | Type |
|---|---|
ID | number |
Title | text |
Description | text |
Fields | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Ticket FormRequired | choice |
FieldRequired | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Label For Customers | text |
Position | number |
Type | text |
Default | text |
Customers Can Edit | boolean |
| Field | Type |
|---|---|
TicketRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Group ID | number |
Agent ID | number |
Ticket ID | number |
Survey ID | number |
Ratings | object |
Default Question Score | number |
Feedback | text |
Created At | date |
| Field | Type |
|---|---|
TicketRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Billable | boolean |
Note | text |
Timer Running | boolean |
Agent ID | number |
Ticket ID | number |
Time Spent (HH:MM) | text |
Created At | date |
| Field | Type |
|---|---|
TicketRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Watcher (Agent) ID | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Business Hour ID | number |
Escalate To | text |
Unassigned For | number |
Auto Ticket Assign | boolean |
Created At | date |
| Field | Type |
|---|---|
Email | |
Mobile | text |
Phone | text |
State | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Available | boolean |
Occasional | boolean |
Signature | text |
Ticket Scope | number |
Type | text |
Available Since | date |
Focus Mode | boolean |
| Field | Type |
|---|---|
Search TermRequired | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | |
Avatar | text |
| Field | Type |
|---|---|
Automation TypeRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Performer | object |
Events | array |
Conditions | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Is Default | boolean |
Time Zone | text |
Business Hours | object |
Monday | object |
Tuesday | object |
Wednesday | object |
Thursday | object |
Friday | object |
Saturday | object |
Sunday | object |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Canned Responses | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Updated Since | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Type | text |
Position | number |
Default | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Label For Customers | text |
Type | text |
Position | number |
Default | text |
Editable In Signup | boolean |
| Field | Type |
|---|---|
Email | |
Mobile | text |
Phone | text |
Company ID | choice |
State | choice |
Contact Type | text |
Updated Since | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
View All Tickets | boolean |
Deleted | boolean |
| Field | Type |
|---|---|
TermRequired | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
Active | boolean |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
To Email | text |
Reply Email | text |
Active | boolean |
Group ID | number |
Product ID | number |
Created At | date |
| Field | Type |
|---|---|
ID | number |
Personalized Email Replies | boolean |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Business Hour ID | number |
Escalate To | number |
Unassigned For | number |
Auto Ticket Assign | boolean |
Created At | date |
| Field | Type |
|---|---|
Primary Language | text |
Supported Languages | array |
Language | text |
Portal Languages | array |
Portal Language | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Support Email | |
Group ID | number |
Product ID | number |
Default Reply Email | boolean |
Mailbox Type | text |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Default | boolean |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Created Since | date |
User | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Ticket ID | number |
User ID | number |
Rating | number |
Feedback | text |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Is Default | boolean |
SLA Target | object |
Applicable To | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
SurveyRequired | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Survey ID | text |
Rating | number |
Feedback | text |
Created At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Active | boolean |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Type | text |
Default | text |
Required For Closure | boolean |
Required For Agents | boolean |
Required For Customers | boolean |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Title | text |
Description | text |
Fields | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Updated Since | date |
Include | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Description (Plain Text) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
| Field | Type |
|---|---|
Agent | choice |
Executed After | date |
Executed Before | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Billable | boolean |
Note | text |
Timer Running | boolean |
Agent ID | number |
Ticket ID | number |
Time Spent (HH:MM) | text |
Created At | date |
| Field | Type |
|---|---|
QueryRequired | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Note | text |
Domains | array |
Custom Fields | object |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
QueryRequired | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
Description | text |
Contact Type | text |
| Field | Type |
|---|---|
Search TermRequired | text |
| Field | Type |
|---|---|
ID | number |
Type | text |
Category ID | number |
Folder ID | number |
Hierarchy | array |
Level | number |
Type | text |
ID | number |
Name | text |
Title | text |
Description | text |
Status | number |
| Field | Type |
|---|---|
QueryRequired | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
Requester ID | number |
Actions
| Field | Type |
|---|---|
TicketRequired | choice |
Agent | choice |
| Field | Type |
|---|---|
TicketsRequired | choice |
| Field | Type |
|---|---|
TicketsRequired | choice |
| Field | Type |
|---|---|
TicketsRequired | choice |
PropertiesRequired | object |
Status | choice |
Priority | choice |
Group | choice |
Assigned Agent | choice |
Tags | array |
| Field | Type |
|---|---|
Import IDRequired | text |
| Field | Type |
|---|---|
Import IDRequired | text |
| Field | Type |
|---|---|
Export ID | number |
Status | text |
Created At | date |
| Field | Type |
|---|---|
EmailRequired | |
Ticket Scope | choice |
Occasional | boolean |
Signature | text |
Group IDs | array |
Role IDs | array |
| Field | Type |
|---|---|
ID | number |
Available | boolean |
Occasional | boolean |
Signature | text |
Ticket Scope | number |
Type | text |
Available Since | date |
Focus Mode | boolean |
| Field | Type |
|---|---|
AgentsRequired | array |
EmailRequired | |
Ticket Scope | choice |
Occasional | boolean |
Signature | text |
Group IDs | array |
Role IDs | array |
| Field | Type |
|---|---|
Agents | array |
| Field | Type |
|---|---|
Automation TypeRequired | choice |
NameRequired | text |
Description | text |
Position | number |
Active | boolean |
ConditionsRequired | array |
Operator | choice |
ActionsRequired | array |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Performer | object |
Events | array |
Conditions | object |
| Field | Type |
|---|---|
TitleRequired | text |
Content (HTML)Required | text |
FolderRequired | choice |
VisibilityRequired | choice |
Group IDs | array |
Attachments | array |
File Content | text |
File Name | text |
| Field | Type |
|---|---|
ID | number |
Title | text |
Folder ID | number |
Content (Plain Text) | text |
Content (HTML) | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
NameRequired | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Canned Responses | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ResponsesRequired | array |
TitleRequired | text |
Content (HTML)Required | text |
FolderRequired | choice |
VisibilityRequired | choice |
Group IDs | array |
| Field | Type |
|---|---|
ID | number |
Title | text |
Folder ID | number |
Content (Plain Text) | text |
Content (HTML) | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
TypeRequired | choice |
ParentRequired | object |
IDRequired | text |
Type | choice |
Additional Info | object |
Email Config ID | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Title | text |
Created By | text |
Parent | object |
ID | text |
Type | text |
Anchor | object |
ID | text |
Type | text |
Participants | object |
Emails | array |
Agents | array |
Linked Object | object |
ID | text |
Type | text |
Attributes | object |
Links | object |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
Industry | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
| Field | Type |
|---|---|
LabelRequired | text |
TypeRequired | text |
Position | number |
Required For Agents | boolean |
Agents Can Edit | boolean |
Displayed For Agents | boolean |
Quick Add For Agent | boolean |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Type | text |
Position | number |
Default | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
NameRequired | text |
Email | |
Phone | text |
Twitter ID | text |
Unique External ID | text |
Company ID | choice |
View All Tickets | boolean |
Other Emails | array |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
View All Tickets | boolean |
Deleted | boolean |
| Field | Type |
|---|---|
LabelRequired | text |
Label For CustomersRequired | text |
TypeRequired | text |
Editable In Signup | boolean |
Position | number |
Required For Agents | boolean |
Agents Can Edit | boolean |
Displayed For Agents | boolean |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Label For Customers | text |
Type | text |
Position | number |
Default | text |
Editable In Signup | boolean |
| Field | Type |
|---|---|
ID | number |
Created At | date |
Status | text |
Total Records | number |
Completed Records | number |
Failures | object |
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Agent IDs | array |
Auto Ticket Assign | choice |
Business Hour | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Business Hour ID | number |
Escalate To | number |
Unassigned For | number |
Auto Ticket Assign | boolean |
Created At | date |
| Field | Type |
|---|---|
Name | text |
Support EmailRequired | |
Group | choice |
Product | choice |
Default Reply Email | boolean |
Mailbox TypeRequired | choice |
Custom Mailbox | object |
Incoming | object |
Outgoing | object |
| Field | Type |
|---|---|
ID | number |
Name | text |
Support Email | |
Group ID | number |
Product ID | number |
Default Reply Email | boolean |
Mailbox Type | text |
Created At | date |
| Field | Type |
|---|---|
SubjectRequired | text |
DescriptionRequired | text |
Requester EmailRequired | |
Email ConfigRequired | choice |
Status | choice |
Priority | choice |
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Description (Plain Text) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
| Field | Type |
|---|---|
FromRequired | object |
Channel IdentifierRequired | text |
ToRequired | object |
Recipient IdentifierRequired | text |
Channel TypeRequired | choice |
MessageRequired | object |
TypeRequired | choice |
TemplateRequired | object |
External Reference ID | text |
Note Policy | object |
On Reply | object |
Ticket Properties | object |
Tags | array |
| Field | Type |
|---|---|
Message ID | text |
From | object |
Channel Identifier | text |
To | object |
Recipient Identifier | text |
Channel Type | text |
External Reference ID | text |
Message | object |
Type | text |
Template | object |
Note Policy | object |
On Reply | object |
Ticket Properties | object |
Tags | array |
Custom Fields | object |
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Position | number |
Active | boolean |
Is Default | boolean |
SLA TargetRequired | object |
Applicable ToRequired | object |
Escalation | object |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Is Default | boolean |
SLA Target | object |
Applicable To | object |
| Field | Type |
|---|---|
SurveyRequired | text |
Rating | text |
Feedback | text |
| Field | Type |
|---|---|
ID | text |
Survey ID | text |
Rating | text |
Feedback | text |
Created At | date |
| Field | Type |
|---|---|
SubjectRequired | text |
DescriptionRequired | text |
Requester Email | |
Requester ID | choice |
Requester Phone | text |
Requester Facebook ID | text |
Requester Twitter ID | text |
Requester Unique External ID | text |
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Description (Plain Text) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
| Field | Type |
|---|---|
TitleRequired | text |
Description | text |
FieldsRequired | array |
Name | text |
Label | text |
Label For Customers | text |
Position | number |
Type | text |
Default | text |
Customers Can Edit | boolean |
Required For Closure | boolean |
Required For Agents | boolean |
Required For Customers | boolean |
| Field | Type |
|---|---|
ID | number |
Title | text |
Description | text |
Fields | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
TicketRequired | choice |
BodyRequired | text |
Private | boolean |
Notify Emails | array |
Attachments | array |
File ContentRequired | text |
File NameRequired | text |
| Field | Type |
|---|---|
ID | number |
Body (HTML) | text |
Body (Plain Text) | text |
Ticket ID | number |
User ID | number |
Incoming | boolean |
Private | boolean |
Support Email | text |
| Field | Type |
|---|---|
TicketRequired | choice |
RatingsRequired | object |
Default Question ScoreRequired | number |
Feedback | text |
| Field | Type |
|---|---|
ID | number |
Group ID | number |
Agent ID | number |
Ticket ID | number |
Survey ID | number |
Ratings | object |
Default Question Score | number |
Feedback | text |
Created At | date |
| Field | Type |
|---|---|
TicketRequired | choice |
Agent | choice |
Time Spent | text |
Billable | boolean |
Note | text |
Executed At | date |
| Field | Type |
|---|---|
ID | number |
Billable | boolean |
Note | text |
Timer Running | boolean |
Agent ID | number |
Ticket ID | number |
Time Spent (HH:MM) | text |
Created At | date |
| Field | Type |
|---|---|
AgentRequired | choice |
| Field | Type |
|---|---|
AttachmentRequired | text |
| Field | Type |
|---|---|
Automation TypeRequired | choice |
Automation Rule IDRequired | choice |
| Field | Type |
|---|---|
Company IDRequired | choice |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
ConversationRequired | text |
| Field | Type |
|---|---|
GroupRequired | choice |
| Field | Type |
|---|---|
MailboxRequired | choice |
| Field | Type |
|---|---|
TicketRequired | choice |
| Field | Type |
|---|---|
Ticket FormRequired | choice |
| Field | Type |
|---|---|
Ticket FormRequired | choice |
FieldRequired | text |
| Field | Type |
|---|---|
Time EntryRequired | choice |
| Field | Type |
|---|---|
TicketRequired | choice |
To EmailsRequired | array |
Body | text |
CC Emails | array |
BCC Emails | array |
| Field | Type |
|---|---|
ID | number |
Body (HTML) | text |
Body (Plain Text) | text |
Ticket ID | number |
User ID | number |
Incoming | boolean |
Private | boolean |
Support Email | text |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | text |
Query String | text |
Body | text |
| Field | Type |
|---|---|
Primary Contact IDRequired | choice |
Secondary Contact IDsRequired | array |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
View All Tickets | boolean |
Deleted | boolean |
| Field | Type |
|---|---|
Primary TicketRequired | choice |
Tickets to MergeRequired | choice |
Convert Recipients to CC | boolean |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
TicketRequired | choice |
| Field | Type |
|---|---|
TicketRequired | choice |
BodyRequired | text |
From Email | |
CC Emails | array |
BCC Emails | array |
| Field | Type |
|---|---|
ID | number |
Body (HTML) | text |
Body (Plain Text) | text |
Ticket ID | number |
User ID | number |
Incoming | boolean |
Private | boolean |
Support Email | text |
| Field | Type |
|---|---|
TicketRequired | choice |
BodyRequired | text |
From Email | |
CC Emails | array |
BCC Emails | array |
| Field | Type |
|---|---|
ID | number |
Body (HTML) | text |
Body (Plain Text) | text |
Ticket ID | number |
User ID | number |
Incoming | boolean |
Private | boolean |
Support Email | text |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
TicketRequired | choice |
| Field | Type |
|---|---|
Time EntryRequired | choice |
| Field | Type |
|---|---|
AgentRequired | choice |
Ticket Scope | choice |
Occasional | boolean |
Signature | text |
Group IDs | array |
Role IDs | array |
| Field | Type |
|---|---|
ID | number |
Available | boolean |
Occasional | boolean |
Signature | text |
Ticket Scope | number |
Type | text |
Available Since | date |
Focus Mode | boolean |
| Field | Type |
|---|---|
AgentRequired | choice |
Channel Availability | object |
Availability Control | choice |
| Field | Type |
|---|---|
Available | boolean |
Available Since | date |
| Field | Type |
|---|---|
Article IDRequired | text |
Title | text |
Description | text |
Agent | choice |
Status | choice |
SEO Data | object |
Meta Title | text |
Meta Description | text |
Meta Keywords | text |
Tags | array |
| Field | Type |
|---|---|
ID | number |
Type | text |
Category ID | number |
Folder ID | number |
Hierarchy | array |
Level | number |
Type | text |
ID | number |
Name | text |
Title | text |
Description | text |
Status | number |
| Field | Type |
|---|---|
Automation TypeRequired | choice |
Automation Rule IDRequired | choice |
Name | text |
Description | text |
Position | number |
Active | boolean |
Conditions | array |
Operator | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Performer | object |
Events | array |
Conditions | object |
| Field | Type |
|---|---|
TicketsRequired | choice |
Agent | choice |
| Field | Type |
|---|---|
Response IDRequired | text |
Title | text |
Content (HTML) | text |
Folder | choice |
Visibility | choice |
Group IDs | array |
Attachments | array |
File Content | text |
File Name | text |
| Field | Type |
|---|---|
ID | number |
Title | text |
Folder ID | number |
Content (Plain Text) | text |
Content (HTML) | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Folder IDRequired | choice |
Name | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Canned Responses | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Company IDRequired | choice |
Name | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Domains | array |
Note | text |
Health Score | text |
Account Tier | text |
Renewal Date | date |
| Field | Type |
|---|---|
Field IDRequired | choice |
Label | text |
Position | number |
Required For Agents | boolean |
Agents Can Edit | boolean |
Displayed For Agents | boolean |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Type | text |
Position | number |
Default | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Contact IDRequired | choice |
Name | text |
Email | |
Phone | text |
Company ID | choice |
View All Tickets | boolean |
Other Emails | array |
Job Title | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
Email | text |
Active | boolean |
Address | text |
Company ID | number |
View All Tickets | boolean |
Deleted | boolean |
| Field | Type |
|---|---|
Field IDRequired | choice |
Label | text |
Label For Customers | text |
Type | text |
Editable In Signup | boolean |
Position | number |
Required For Agents | boolean |
Agents Can Edit | boolean |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Label For Customers | text |
Type | text |
Position | number |
Default | text |
Editable In Signup | boolean |
| Field | Type |
|---|---|
ConversationRequired | text |
BodyRequired | text |
Attachments | array |
File ContentRequired | text |
File NameRequired | text |
| Field | Type |
|---|---|
Personalized Email Replies | boolean |
| Field | Type |
|---|---|
ID | number |
Personalized Email Replies | boolean |
| Field | Type |
|---|---|
GroupRequired | choice |
Name | text |
Description | text |
Agent IDs | array |
Auto Ticket Assign | choice |
Business Hour | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Business Hour ID | number |
Escalate To | number |
Unassigned For | number |
Auto Ticket Assign | boolean |
Created At | date |
| Field | Type |
|---|---|
MailboxRequired | choice |
Name | text |
Support Email | |
Group | choice |
Product | choice |
Default Reply Email | boolean |
Mailbox Type | choice |
Custom Mailbox | object |
Incoming | object |
Outgoing | object |
| Field | Type |
|---|---|
ID | number |
Name | text |
Support Email | |
Group ID | number |
Product ID | number |
Default Reply Email | boolean |
Mailbox Type | text |
Created At | date |
| Field | Type |
|---|---|
SLA Policy IDRequired | choice |
Name | text |
Description | text |
Position | number |
Active | boolean |
Is Default | boolean |
SLA Target | object |
Applicable To | object |
| Field | Type |
|---|---|
ID | number |
Name | text |
Description | text |
Position | number |
Active | boolean |
Is Default | boolean |
SLA Target | object |
Applicable To | object |
| Field | Type |
|---|---|
TicketRequired | choice |
Subject | text |
Description | text |
Requester Email | |
Requester ID | choice |
Requester Phone | text |
Status | choice |
Priority | choice |
| Field | Type |
|---|---|
ID | number |
Subject | text |
Description (HTML) | text |
Description (Plain Text) | text |
Status | number |
Priority | number |
Source | number |
Type | text |
| Field | Type |
|---|---|
Ticket FormRequired | choice |
Title | text |
Description | text |
Fields | array |
Name | text |
Label | text |
Label For Customers | text |
Position | number |
Type | text |
Default | text |
Customers Can Edit | boolean |
Required For Closure | boolean |
Required For Agents | boolean |
Required For Customers | boolean |
| Field | Type |
|---|---|
ID | number |
Title | text |
Description | text |
Fields | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Ticket FormRequired | choice |
FieldRequired | text |
Label For Customers | text |
Customers Can Edit | boolean |
Required For Closure | boolean |
Required For Agents | boolean |
Required For Customers | boolean |
Displayed To Customers | boolean |
| Field | Type |
|---|---|
ID | number |
Name | text |
Label | text |
Label For Customers | text |
Position | number |
Type | text |
Default | text |
Customers Can Edit | boolean |
| Field | Type |
|---|---|
Time EntryRequired | choice |
Agent | choice |
Time Spent | text |
Billable | boolean |
Note | text |
Executed At | date |
| Field | Type |
|---|---|
ID | number |
Billable | boolean |
Note | text |
Timer Running | boolean |
Agent ID | number |
Ticket ID | number |
Time Spent (HH:MM) | text |
Created At | date |