About this integration
Customer messaging and help desk — contacts, conversations, tickets, and the Fin knowledge library. Use it from the workflow canvas with no custom glue script required.
This integration exposes 3 triggers, 114 search modules and 118 actions as workflow nodes. Authentication uses oauth or basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Client ID, Client Secret, Region, and Access Token.
Prefer the interactive builder form? Open it on the app page.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | Developer Hub → Basic Information → Client ID. Optional if a platform app is registered in |
Client SecretRequired | password | Developer Hub → Basic Information → Client secret. |
RegionRequired | select | Workspace data region. Must match the authorize host. |
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Access TokenRequired | password | Intercom Developer Hub → your app → Authentication. Treat it like a password. |
RegionRequired | select | Workspace data region. US, EU, or Australia. |
Use it in workflow automation
Start with Watch Contacts, then add Add Contact to Company.
Triggers, searches and actions
Use the tables below to inspect Intercom's 3 triggers, 114 search modules, and 118 actions.
Triggers
3 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Contacts
- Watch Conversations
- Watch Events
Searches
Fetch data on demand using 114 search modules that query the app during a run.
- Download Content Data Export
- Download Reporting Data Export
- Get Admin
- Get Article
- Get Article Draft
Actions
118 action modules cover the full range of create, update, and delete operations.
- Add Contact to Company
- Add Contact to Conversation
- Add Conversation Attribute Option
- Add Subscription to Contact
- Add Tag to Article
Explore the fields available for each Intercom trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Email | |
Role | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Source | object |
Type | text |
Subject | text |
Body | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Topic | text |
Created At | number |
Data | object |
Type | text |
Item | object |
Searches
| Field | Type |
|---|---|
Job IdentifierRequired | text |
| Field | Type |
|---|---|
Job IdentifierRequired | text |
| Field | Type |
|---|---|
AdminRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
| Field | Type |
|---|---|
ArticleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Statistics | object |
Type | text |
Views | number |
Conversations | number |
Reactions | number |
Happy Reaction Percentage | number |
Neutral Reaction Percentage | number |
Sad Reaction Percentage | number |
| Field | Type |
|---|---|
ArticleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Title | text |
| Field | Type |
|---|---|
ArticleRequired | choice |
VersionRequired | text |
Locale | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Article ID | text |
Title | text |
Description | text |
| Field | Type |
|---|---|
AudienceRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Predicates | object |
Type | text |
Role Predicates | object |
Type | text |
| Field | Type |
|---|---|
BrandRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
| Field | Type |
|---|---|
CallRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Conversation Id | text |
Admin Id | text |
Contact Id | text |
| Field | Type |
|---|---|
CallRequired | choice |
| Field | Type |
|---|---|
CallRequired | choice |
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
ID | text |
Workspace ID | text |
Name | text |
Url | text |
Order | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Include Merge History | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
External Id | text |
Role | text |
| Field | Type |
|---|---|
External IDRequired | text |
Include Merge History | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
External Id | text |
Role | text |
| Field | Type |
|---|---|
Job IdentifierRequired | text |
| Field | Type |
|---|---|
Job Identifier | text |
Status | text |
Download URL | text |
| Field | Type |
|---|---|
Content Import SourceRequired | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
URL | text |
Status | text |
Sync Behavior | text |
| Field | Type |
|---|---|
Content SnippetRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Title | text |
Locale | text |
Json Blocks | object |
Type | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Display As | text |
Include Translations | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | text |
| Field | Type |
|---|---|
Conversation Attribute IDRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Email | |
Name | text |
Email Verified | boolean |
| Field | Type |
|---|---|
Custom Object Type IdentifierRequired | text |
Custom Object Instance IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
External ID | text |
| Field | Type |
|---|---|
Data ConnectorRequired | choice |
State Version | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
State | text |
| Field | Type |
|---|---|
Data ConnectorRequired | choice |
Execution Result IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Success | boolean |
| Field | Type |
|---|---|
Email Setting IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
| Field | Type |
|---|---|
External PageRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Title | text |
Html | text |
URL | text |
| Field | Type |
|---|---|
IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Phone Number | text |
Call ID | text |
| Field | Type |
|---|---|
External IDRequired | text |
| Field | Type |
|---|---|
ID | text |
External ID | text |
| Field | Type |
|---|---|
Phone NumberRequired | text |
| Field | Type |
|---|---|
ID | text |
Phone Number | text |
| Field | Type |
|---|---|
Help CenterRequired | choice |
| Field | Type |
|---|---|
ID | text |
Workspace ID | text |
Created At | number |
Updated At | number |
Identifier | text |
| Field | Type |
|---|---|
Help CenterRequired | choice |
RedirectRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
From Url | text |
Locale | text |
Help Center ID | text |
| Field | Type |
|---|---|
Internal ArticleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Body | text |
Owner ID | number |
Author ID | number |
Locale | text |
| Field | Type |
|---|---|
Type | text |
Enabled | boolean |
| Field | Type |
|---|---|
Job IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Status | text |
| Field | Type |
|---|---|
MacroRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Body | text |
Body Text | text |
| Field | Type |
|---|---|
Ruleset IDRequired | text |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Conversation Id | text |
User Id | text |
Status | text |
Type | text |
| Field | Type |
|---|---|
NewsfeedRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Created At | number |
Updated At | number |
| Field | Type |
|---|---|
News ItemRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Title | text |
Body | text |
| Field | Type |
|---|---|
Contact | choice |
Company | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Contact | object |
Type | text |
Id | text |
Author | object |
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
Away Mode Reassign | boolean |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
Exception IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Exception Date | text |
Exception Type | text |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Time Zone Name | text |
| Field | Type |
|---|---|
Job IdentifierRequired | text |
| Field | Type |
|---|---|
Job Identifier | text |
Status | text |
Download URL | text |
| Field | Type |
|---|---|
SegmentRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Created At | number |
Updated At | number |
| Field | Type |
|---|---|
TagRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
| Field | Type |
|---|---|
TeamRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Assignment Limit | number |
Distribution Method | text |
| Field | Type |
|---|---|
TeamRequired | choice |
Idle Threshold | number |
| Field | Type |
|---|---|
Type | text |
Data | array |
| Field | Type |
|---|---|
TicketRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Ticket Id | text |
Ticket Attributes | object |
Default Title | text |
Default Description | text |
Ticket State | object |
Type | text |
Id | text |
Category | text |
Internal Label | text |
External Label | text |
| Field | Type |
|---|---|
Ticket TypeRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Description | text |
Icon | text |
| Field | Type |
|---|---|
User IDRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
User Id | text |
Anonymous | boolean |
Email |
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
Conversation Id | text |
Status | text |
Type | text |
Created At | number |
Updated At | number |
| Field | Type |
|---|---|
IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Created At AfterRequired | number |
Created At Before | number |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Performed By | object |
Type | text |
Id | text |
Email | |
Ip | text |
Metadata | object |
Before | text |
After | text |
Created At | number |
Activity Type | text |
| Field | Type |
|---|---|
Display Avatar | boolean |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Email | |
Id | text |
Name | text |
Away Mode Enabled | boolean |
| Field | Type |
|---|---|
Order | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Tags | object |
Type | text |
Tags | text |
| Field | Type |
|---|---|
ArticleRequired | choice |
Locale | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Article ID | text |
Title | text |
Description | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Predicates | object |
Type | text |
Role Predicates | object |
Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Label | text |
Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Conversation Id | text |
Admin Id | text |
Contact Id | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Workspace ID | text |
Name | text |
Url | text |
Order | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Total Count | number |
Pages | object |
Type | text |
Page | number |
Per Page | number |
Total Pages | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Company | object |
Type | text |
Id | text |
Author | object |
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
Away Mode Reassign | boolean |
Away Status Reason Id | text |
Has Inbox Seat | boolean |
| Field | Type |
|---|---|
CompanyRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
View Id | text |
Title | text |
Body | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Order | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Source Contact Id | text |
Source Contact Role | text |
Merged At | number |
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Contact | object |
Type | text |
Id | text |
Author | object |
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
Away Mode Reassign | boolean |
| Field | Type |
|---|---|
Include Merge History | boolean |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Total Count | number |
Pages | object |
Type | text |
Page | number |
Per Page | number |
Total Pages | number |
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Created At | number |
Updated At | number |
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
State | text |
Consent Type | text |
Default Translation | object |
Name | text |
Description | text |
Locale | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Type | text |
URL | text |
Status | text |
Sync Behavior | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Title | text |
Locale | text |
Json Blocks | object |
Type | text |
| Field | Type |
|---|---|
Include Archived | boolean |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | text |
| Field | Type |
|---|---|
Custom Object Type IdentifierRequired | text |
Contact | choice |
Conversation | choice |
External ID | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
External ID | text |
| Field | Type |
|---|---|
Model | choice |
Include Archived | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Model | text |
Data Type | text |
| Field | Type |
|---|---|
Data ConnectorRequired | choice |
Success | boolean |
Error Type | text |
Start Ts | number |
End Ts | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Success | boolean |
Error Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
URL | text |
State | text |
| Field | Type |
|---|---|
TypeRequired | choice |
Contact | choice |
User ID | text |
Email | |
Summary | boolean |
| Field | Type |
|---|---|
Type | text |
Event Name | text |
Created At | number |
Email |
| Field | Type |
|---|---|
Order | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Metrics Retained | boolean |
Deleted At | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Title | text |
URL | text |
Html | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Phone Number | text |
Call ID | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Teammate | object |
Type | text |
Id | number |
Name | text |
Email | |
Type | text |
Timestamp | text |
Reason | text |
| Field | Type |
|---|---|
Help CenterRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
From Url | text |
Locale | text |
Help Center ID | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Workspace ID | text |
Created At | number |
Updated At | number |
Identifier | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
Body | text |
Owner ID | number |
Author ID | number |
| Field | Type |
|---|---|
NewsfeedRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Title | text |
Body | text |
| Field | Type |
|---|---|
Updated Since | number |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Body | text |
Body Text | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Created At | number |
Updated At | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Title | text |
Body | text |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Exception Date | text |
Exception Type | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Time Zone Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
Description | text |
| Field | Type |
|---|---|
Include Count | boolean |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Created At | number |
Updated At | number |
| Field | Type |
|---|---|
ConversationRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Side Conversation Id | text |
Total Count | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
State | text |
Consent Type | text |
Default Translation | object |
Name | text |
Description | text |
Locale | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Assignment Limit | number |
Distribution Method | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Category | text |
Internal Label | text |
External Label | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Description | text |
Icon | text |
| Field | Type |
|---|---|
Name | text |
Company ID | text |
Tag | choice |
Segment | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
Scroll Param | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
Created At AfterRequired | number |
Created At Before | number |
Event Types | array |
Event Type | text |
Limit | number |
| Field | Type |
|---|---|
Id | text |
Performed By | object |
Type | text |
Id | text |
Email | |
Ip | text |
Metadata | object |
Before | text |
After | text |
Created At | number |
Activity Type | text |
| Field | Type |
|---|---|
Phrase | text |
State | choice |
Help Center | choice |
Highlight | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Tags | object |
Type | text |
Tags | text |
| Field | Type |
|---|---|
ConversationsRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Conversation Id | text |
Transcript | array |
Transcript Status | text |
| Field | Type |
|---|---|
QueryRequired | object |
FieldRequired | text |
OperatorRequired | choice |
ValueRequired | text |
Include Merge History | boolean |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Total Count | number |
Pages | object |
Type | text |
Page | number |
Per Page | number |
Total Pages | number |
| Field | Type |
|---|---|
Query | text |
States | choice |
Locales | array |
Tags | choice |
Tag Operator | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Title | text |
| Field | Type |
|---|---|
QueryRequired | object |
FieldRequired | text |
OperatorRequired | choice |
ValueRequired | text |
Include Monitors | boolean |
Include Scorecards | boolean |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | text |
| Field | Type |
|---|---|
Folder ID | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Body | text |
Owner ID | number |
Author ID | number |
Locale | text |
| Field | Type |
|---|---|
QueryRequired | object |
FieldRequired | text |
OperatorRequired | choice |
ValueRequired | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Ticket Id | text |
Ticket Attributes | object |
Default Title | text |
Default Description | text |
Ticket State | object |
Type | text |
Id | text |
Category | text |
Internal Label | text |
External Label | text |
Actions
| Field | Type |
|---|---|
ContactRequired | choice |
CompanyRequired | choice |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Admin | choice |
Contact | choice |
Email | |
User ID | text |
| Field | Type |
|---|---|
Conversation Attribute IDRequired | text |
LabelRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Subscription TypeRequired | choice |
Consent TypeRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
State | text |
Consent Type | text |
Default Translation | object |
Name | text |
Description | text |
Locale | text |
| Field | Type |
|---|---|
ArticleRequired | choice |
TagRequired | choice |
Admin | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
ID | text |
| Field | Type |
|---|---|
ContactRequired | choice |
TagRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
Content SnippetRequired | choice |
TagRequired | choice |
Admin | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
ID | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
TagRequired | choice |
AdminRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
Internal ArticleRequired | choice |
TagRequired | choice |
Admin | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
ID | text |
| Field | Type |
|---|---|
TicketRequired | text |
TagRequired | choice |
AdminRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
Job IdentifierRequired | text |
| Field | Type |
|---|---|
Job Identifier | text |
Status | text |
| Field | Type |
|---|---|
TicketRequired | text |
Ticket TypeRequired | choice |
Ticket StateRequired | choice |
Ticket Attributes | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Ticket Id | text |
Ticket Attributes | object |
Default Title | text |
Default Description | text |
Ticket State | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Ticket TypeRequired | choice |
Ticket State | choice |
Attributes | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Ticket Id | text |
Ticket State | object |
Type | text |
Id | text |
Category | text |
Internal Label | text |
External Label | text |
Contacts | object |
Type | text |
| Field | Type |
|---|---|
TypeRequired | choice |
UserRequired | object |
ID | text |
User ID | text |
Email | |
VisitorRequired | object |
ID | text |
User ID | text |
Email |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
External Id | text |
Role | text |
| Field | Type |
|---|---|
TitleRequired | text |
AuthorRequired | choice |
Description | text |
Body | text |
Body Markdown | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Statistics | object |
Type | text |
Views | number |
Conversations | number |
Reactions | number |
Happy Reaction Percentage | number |
Neutral Reaction Percentage | number |
Sad Reaction Percentage | number |
| Field | Type |
|---|---|
NameRequired | text |
Predicates | array |
Predicate | object |
Role Predicates | array |
Predicate | object |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Predicates | object |
Type | text |
Role Predicates | object |
Type | text |
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Translated Content | text |
Parent | choice |
Help Center | choice |
| Field | Type |
|---|---|
ID | text |
Workspace ID | text |
Name | text |
Url | text |
Order | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
BodyRequired | text |
Admin | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Company | object |
Type | text |
Id | text |
Author | object |
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
Away Mode Reassign | boolean |
| Field | Type |
|---|---|
Role | text |
External ID | text |
Email | |
Email Verified | boolean |
Phone | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
External Id | text |
Role | text |
| Field | Type |
|---|---|
ContactRequired | choice |
BodyRequired | text |
Admin | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Contact | object |
Type | text |
Id | text |
Author | object |
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
Away Mode Reassign | boolean |
| Field | Type |
|---|---|
Created At AfterRequired | number |
Created At BeforeRequired | number |
| Field | Type |
|---|---|
Job Identifier | text |
Status | text |
| Field | Type |
|---|---|
Sync BehaviorRequired | choice |
URLRequired | url |
Status | choice |
Audience IDs | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
URL | text |
Status | text |
Sync Behavior | text |
| Field | Type |
|---|---|
TitleRequired | text |
JSON Blocks | text |
Body Markdown | text |
Locale | text |
Audiences | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Title | text |
Locale | text |
Json Blocks | object |
Type | text |
| Field | Type |
|---|---|
FromRequired | object |
TypeRequired | choice |
ContactRequired | choice |
BodyRequired | text |
Subject | text |
Attachment URLs | array |
URL | url |
Created At | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Body | text |
Message Type | text |
| Field | Type |
|---|---|
NameRequired | text |
Data TypeRequired | choice |
Description | text |
Required | boolean |
Visible To Teams | choice |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
NameRequired | text |
ModelRequired | choice |
Data TypeRequired | choice |
Description | text |
Messenger Writable | boolean |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Model | text |
Data Type | text |
| Field | Type |
|---|---|
NameRequired | text |
Http Method | choice |
URL | url |
Body | text |
Direct Fin Usage | boolean |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
URL | text |
| Field | Type |
|---|---|
Event NameRequired | text |
Created AtRequired | number |
Contact | choice |
User ID | text |
Email |
| Field | Type |
|---|---|
User ID | text |
Event Summaries | object |
Event Name | text |
Count | number |
First | number |
Last | number |
| Field | Type |
|---|---|
TitleRequired | text |
HtmlRequired | text |
LocaleRequired | choice |
Content Import SourceRequired | choice |
External IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Title | text |
Html | text |
URL | text |
| Field | Type |
|---|---|
Help CenterRequired | choice |
From URLRequired | url |
LocaleRequired | text |
Target TypeRequired | choice |
Target IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
From Url | text |
Locale | text |
Help Center ID | text |
| Field | Type |
|---|---|
TitleRequired | text |
OwnerRequired | choice |
AuthorRequired | choice |
Body | text |
Body Markdown | text |
| Field | Type |
|---|---|
ID | text |
Title | text |
Body | text |
Owner ID | number |
Author ID | number |
| Field | Type |
|---|---|
Message TypeRequired | choice |
FromRequired | object |
TypeRequired | choice |
AdminRequired | choice |
ToRequired | object |
TypeRequired | choice |
ContactRequired | choice |
Subject | text |
Body | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Body | text |
Message Type | text |
| Field | Type |
|---|---|
TitleRequired | text |
SenderRequired | choice |
Body | text |
State | choice |
Deliver Silently | boolean |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Title | text |
Body | text |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
Exception DateRequired | text |
Exception TypeRequired | choice |
Name | text |
Time Intervals | array |
Interval | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Exception Date | text |
Exception Type | text |
| Field | Type |
|---|---|
NameRequired | text |
Time Zone NameRequired | text |
Time IntervalsRequired | array |
Interval | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Time Zone Name | text |
| Field | Type |
|---|---|
Name | text |
Company ID | text |
Plan | text |
Size | number |
Website | url |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
Custom Object Type IdentifierRequired | text |
External ID | text |
External Created At | number |
External Updated At | number |
Custom Attributes | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
External ID | text |
| Field | Type |
|---|---|
NameRequired | text |
Tag | choice |
Companies | array |
Company | object |
Users | array |
User | object |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
| Field | Type |
|---|---|
PhoneRequired | text |
Custom Attributes | text |
| Field | Type |
|---|---|
Url | url |
Type | text |
| Field | Type |
|---|---|
Ticket TypeRequired | choice |
ContactsRequired | array |
Contact | object |
Conversation To Link | choice |
Company | choice |
Created At | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Ticket Id | text |
Ticket Attributes | object |
Default Title | text |
Default Description | text |
Ticket State | object |
Type | text |
Id | text |
Category | text |
Internal Label | text |
External Label | text |
| Field | Type |
|---|---|
NameRequired | text |
Description | text |
Category | choice |
Icon | text |
Is Internal | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Description | text |
Icon | text |
| Field | Type |
|---|---|
Ticket TypeRequired | choice |
NameRequired | text |
DescriptionRequired | text |
Data TypeRequired | choice |
Required To Create | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
Name | text |
Description | text |
| Field | Type |
|---|---|
ArticleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
AudienceRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
CollectionRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
CompanyRequired | choice |
| Field | Type |
|---|---|
Id | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
Content Import SourceRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Content SnippetRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
ConversationRequired | choice |
Retain Metrics | boolean |
| Field | Type |
|---|---|
Id | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Conversation Attribute IDRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
Conversation Attribute IDRequired | text |
Option IDRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
Custom Object Type IdentifierRequired | text |
Custom Object Instance IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Custom Object Type IdentifierRequired | text |
External IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Data ConnectorRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
External PageRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Help CenterRequired | choice |
RedirectRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Internal ArticleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
News ItemRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
Exception IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
TagRequired | choice |
| Field | Type |
|---|---|
TicketRequired | text |
| Field | Type |
|---|---|
Id | text |
Object | text |
Deleted | boolean |
| Field | Type |
|---|---|
ContactRequired | choice |
View IDRequired | text |
| Field | Type |
|---|---|
Type | text |
View Id | text |
Dismissed | boolean |
| Field | Type |
|---|---|
Ticket TypeRequired | choice |
ContactsRequired | array |
Contact | object |
Conversation To Link | choice |
Company | choice |
Created At | number |
| Field | Type |
|---|---|
Type | text |
Id | text |
Status | text |
Url | text |
Resource Type | text |
| Field | Type |
|---|---|
DatasetRequired | choice |
Attribute IDsRequired | array |
Start TimeRequired | number |
End TimeRequired | number |
| Field | Type |
|---|---|
Job Identifier | text |
Status | text |
| Field | Type |
|---|---|
TicketRequired | text |
ConversationRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Source | object |
Type | text |
Id | text |
Delivered As | text |
Subject | text |
Body | text |
Redacted | boolean |
| Field | Type |
|---|---|
URLRequired | 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 |
|---|---|
ConversationRequired | choice |
Message Type | choice |
Admin | choice |
Type | choice |
Assignee ID | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | text |
| Field | Type |
|---|---|
FromRequired | choice |
IntoRequired | choice |
Skip Duplicate Validation | boolean |
Include Merge History | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
External Id | text |
Role | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Merge IntoRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | number |
| Field | Type |
|---|---|
ArticleRequired | choice |
Locales | array |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Title | text |
| Field | Type |
|---|---|
Type | choice |
Conversation | choice |
Conversation Part ID | text |
Source ID | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | number |
| Field | Type |
|---|---|
Phone NumberRequired | text |
Call IDRequired | text |
Source | choice |
Data | text |
| Field | Type |
|---|---|
ID | text |
Phone Number | text |
Call ID | text |
| Field | Type |
|---|---|
ContactRequired | choice |
CompanyRequired | choice |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
ContactRequired | choice |
AdminRequired | choice |
| Field | Type |
|---|---|
TicketRequired | text |
ConversationRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Source | object |
Type | text |
Id | text |
Delivered As | text |
Subject | text |
Body | text |
Redacted | boolean |
| Field | Type |
|---|---|
ContactRequired | choice |
Subscription TypeRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
State | text |
Consent Type | text |
Default Translation | object |
Name | text |
Description | text |
Locale | text |
| Field | Type |
|---|---|
ArticleRequired | choice |
TagRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Applied At | text |
Applied By | text |
| Field | Type |
|---|---|
ContactRequired | choice |
TagRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
Content SnippetRequired | choice |
TagRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Applied At | text |
Applied By | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
TagRequired | choice |
AdminRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
Internal ArticleRequired | choice |
TagRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Applied At | text |
Applied By | text |
| Field | Type |
|---|---|
TagRequired | choice |
TicketRequired | text |
AdminRequired | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Applied At | number |
Applied By | object |
Type | text |
Id | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Message Type | choice |
Type | choice |
Admin | choice |
Body | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | number |
| Field | Type |
|---|---|
ConversationRequired | choice |
MessageRequired | object |
AuthorRequired | choice |
BodyRequired | text |
TimestampRequired | text |
Timestamp Ms | text |
UserRequired | object |
ContactRequired | choice |
Name | text |
Email | |
Attributes | text |
Attachments | array |
Attachment | object |
| Field | Type |
|---|---|
Conversation ID | text |
Status | text |
| Field | Type |
|---|---|
TicketRequired | text |
Message Type | choice |
Type | choice |
Admin | choice |
Body | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Part Type | text |
Body | text |
Created At | number |
| Field | Type |
|---|---|
ActionRequired | choice |
Content IDsRequired | array |
Content | object |
Availability | object |
Ai Agent | boolean |
Copilot | boolean |
Sales Agent | boolean |
Audience | object |
Add Segments | choice |
Remove Segments | choice |
Remove All | boolean |
Tags | object |
Add Tags | choice |
Remove Tags | choice |
| Field | Type |
|---|---|
AdminRequired | choice |
Away Mode EnabledRequired | boolean |
Away Mode ReassignRequired | boolean |
Away Status Reason | choice |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Email | |
Away Mode Enabled | boolean |
| Field | Type |
|---|---|
ArticleRequired | choice |
Title | text |
Description | text |
Body | text |
Body Markdown | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Title | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
MessageRequired | object |
AuthorRequired | choice |
BodyRequired | text |
TimestampRequired | text |
Timestamp Ms | text |
UserRequired | object |
ContactRequired | choice |
Name | text |
Email | |
Attributes | text |
Attachments | array |
Attachment | object |
Conversation Metadata | object |
History | array |
Attributes | text |
| Field | Type |
|---|---|
Conversation ID | text |
Status | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
RatingRequired | choice |
Remark | text |
| Field | Type |
|---|---|
Conversation ID | text |
Rating | text |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
ArticleRequired | choice |
Title | text |
Description | text |
Body | text |
Body Markdown | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Parent Ids | object |
Type | text |
Statistics | object |
Type | text |
Views | number |
Conversations | number |
Reactions | number |
Happy Reaction Percentage | number |
Neutral Reaction Percentage | number |
Sad Reaction Percentage | number |
| Field | Type |
|---|---|
AudienceRequired | choice |
Name | text |
Predicates | array |
Predicate | object |
Role Predicates | array |
Predicate | object |
| Field | Type |
|---|---|
Type | text |
ID | text |
Name | text |
Predicates | object |
Type | text |
Role Predicates | object |
Type | text |
| Field | Type |
|---|---|
CollectionRequired | choice |
Name | text |
Description | text |
Translated Content | text |
Parent | choice |
| Field | Type |
|---|---|
ID | text |
Workspace ID | text |
Name | text |
Url | text |
Order | number |
| Field | Type |
|---|---|
CompanyRequired | choice |
Name | text |
Plan | text |
Size | number |
Website | url |
| Field | Type |
|---|---|
Type | text |
Company Id | text |
Id | text |
App Id | text |
Name | text |
| Field | Type |
|---|---|
ContactRequired | choice |
Role | text |
External ID | text |
Email | |
Email Verified | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
External Id | text |
Role | text |
| Field | Type |
|---|---|
Content Import SourceRequired | choice |
Sync BehaviorRequired | choice |
URLRequired | url |
Status | choice |
Audience IDs | choice |
| Field | Type |
|---|---|
ID | number |
Type | text |
URL | text |
Status | text |
Sync Behavior | text |
| Field | Type |
|---|---|
Content SnippetRequired | choice |
Title | text |
JSON Blocks | text |
Body Markdown | text |
Locale | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Title | text |
Locale | text |
Json Blocks | object |
Type | text |
| Field | Type |
|---|---|
ConversationRequired | choice |
Read | boolean |
Title | text |
Company | choice |
Custom Attributes | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Created At | number |
Updated At | number |
Waiting Since | text |
| Field | Type |
|---|---|
Conversation Attribute IDRequired | text |
Name | text |
Description | text |
Multiline | boolean |
Required | boolean |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
Conversation Attribute IDRequired | text |
Option IDRequired | text |
LabelRequired | text |
| Field | Type |
|---|---|
Type | text |
Id | number |
Name | text |
Description | text |
Data Type | text |
| Field | Type |
|---|---|
Data AttributeRequired | choice |
Archived | boolean |
Description | text |
Messenger Writable | boolean |
Options | array |
Option | object |
| Field | Type |
|---|---|
ID | number |
Type | text |
Name | text |
Description | text |
| Field | Type |
|---|---|
Data ConnectorRequired | choice |
State | choice |
Name | text |
Http Method | choice |
URL | url |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
State | text |
| Field | Type |
|---|---|
External PageRequired | choice |
TitleRequired | text |
HtmlRequired | text |
URLRequired | url |
LocaleRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Title | text |
Html | text |
URL | text |
| Field | Type |
|---|---|
Internal ArticleRequired | choice |
Title | text |
Body | text |
Body Markdown | text |
Author | choice |
| Field | Type |
|---|---|
ID | text |
Body | text |
Owner ID | number |
Author ID | number |
Locale | text |
| Field | Type |
|---|---|
Enabled | boolean |
Ip Allowlist | array |
Type | text |
| Field | Type |
|---|---|
Type | text |
Enabled | boolean |
| Field | Type |
|---|---|
News ItemRequired | choice |
TitleRequired | text |
SenderRequired | choice |
Body | text |
State | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Workspace ID | text |
Title | text |
Body | text |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
Exception IDRequired | text |
Exception Date | text |
Exception Type | choice |
Name | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Exception Date | text |
Exception Type | text |
| Field | Type |
|---|---|
Office Hours ScheduleRequired | choice |
Name | text |
Time Zone Name | text |
Time Intervals | array |
Interval | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Time Zone Name | text |
| Field | Type |
|---|---|
TicketRequired | text |
Ticket Attributes | text |
Ticket State | choice |
Company | choice |
Open | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Ticket Id | text |
Ticket Attributes | object |
Default Title | text |
Default Description | text |
Ticket State | object |
Type | text |
Id | text |
Category | text |
Internal Label | text |
External Label | text |
| Field | Type |
|---|---|
Ticket TypeRequired | choice |
Name | text |
Description | text |
Category | choice |
Icon | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
Name | text |
Description | text |
Icon | text |
| Field | Type |
|---|---|
Ticket TypeRequired | choice |
Attribute IDRequired | text |
Name | text |
Description | text |
Required To Create | boolean |
| Field | Type |
|---|---|
Type | text |
Id | text |
Workspace Id | text |
Name | text |
Description | text |
| Field | Type |
|---|---|
ID | text |
User ID | text |
Name | text |
Custom Attributes | text |
| Field | Type |
|---|---|
Type | text |
Id | text |
User Id | text |
Anonymous | boolean |
Email |