About this integration
Customer service CRM for conversations, customers, and support automation. Use it from the workflow canvas with no custom glue script required.
This integration exposes 7 triggers, 42 search modules and 47 actions as workflow nodes. Authentication uses basic authentication.
How to connect
The credential form asks for Organization Name 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.
You can create and retrieve your API Key by checking: https://help.kustomer.com/api-keys-SJs5YTIWX
Connecting Kustomer to WEXTL®
| Field | Type | Help |
|---|---|---|
Organization NameRequired | text | Your organization name. For example, if your URL is https://here.api.kustomerapp.com, then your organization name is |
API KeyRequired | password | Your API key. You can create and retrieve your API Key by checking: https://help.kustomer.com/api-keys-SJs5YTIWX. |
Use it in workflow automation
Start with Watch Conversations, then add Create a Conversation.
The canvas below runs Watch Conversations into Create a Conversation — watch the video, then drop a node onto the canvas.
Select the Watch Conversations trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Conversation Forward as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 54 ready-made modules for support work — each run logs its inputs and outputs for debugging.
Kustomer workflow on the canvas: Watch Conversations then Create a Conversation Forward
Triggers, searches and actions
Use the tables below to inspect Kustomer's 7 triggers, 42 search modules, and 47 actions.
Triggers
7 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Conversations
- Watch Customers
- Watch Messages
- Watch Notes
- Watch Teams
Searches
Fetch data on demand using 42 search modules that query the app during a run.
- Get a Conversation
- Get a Conversation by External ID
- Get a Customer
- Get a Customer by Email
- Get a Customer by External ID
Actions
47 action modules cover the full range of create, update, and delete operations.
- Create a Conversation
- Create a Conversation
- Create a Conversation Forward
- Create a Conversation Message
- Create a Conversation Tag
Explore the fields available for each Kustomer trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ids | array |
Shared external ids | array |
Emails | array |
Shared emails | array |
Phones | array |
Shared phones | array |
Relationships | object |
Org | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Sent at | date |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Display name | text |
Avatar URL | text |
Name | text |
User type | text |
Email | |
Mobile | text |
Email signature | text |
Password | object |
Roles | array |
Role groups | array |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
Queued count | number |
Priority | number |
Item size | number |
Updated at | date |
Modified at | date |
Created at | date |
Relationships | object |
Org | object |
Resource | object |
Last revision | object |
Assigned to | object |
Accepted by | object |
Links | object |
Self | text |
Searches
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
External IDRequired | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ID | text |
External ids | array |
Shared external ids | array |
Signed up at | date |
Avatar URL | text |
Username | text |
Relationships | object |
Org | object |
Messages | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
EmailRequired |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ID | text |
External ids | array |
Shared external ids | array |
Signed up at | date |
Avatar URL | text |
Username | text |
Relationships | object |
Org | object |
Messages | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
External IDRequired | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ID | text |
External ids | array |
Shared external ids | array |
Signed up at | date |
Avatar URL | text |
Username | text |
Relationships | object |
Org | object |
Messages | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Phone NumberRequired | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ID | text |
External ids | array |
Shared external ids | array |
Signed up at | date |
Avatar URL | text |
Username | text |
Relationships | object |
Org | object |
Messages | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Event IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Type | text |
Published at | date |
Created at | date |
Updated at | date |
Modified at | date |
Changes | object |
Location | text |
Meta | text |
Relationships | object |
Org | object |
Created by | text |
Modified by | text |
Customer | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Merge IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Status | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Source | object |
Target | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Message IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Lang | text |
Relationships | object |
Org | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Message IDRequired | choice |
Attachment IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Redacted | boolean |
Relationships | object |
Org | object |
Message | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
External IDRequired | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Lang | text |
Relationships | object |
Org | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Attachment IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Uploaded | boolean |
Redacted | boolean |
Relationships | object |
Org | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Note IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Work Item IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
Queued count | number |
Priority | number |
Item size | number |
Ivr | object |
Handle | object |
Wrap up | object |
Relationships | object |
Org | object |
Resource | object |
Last revision | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Unique IDsRequired | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Created by teams | array |
Assigned users | array |
Assigned teams | array |
Handle at | date |
Handle time | number |
Channels | array |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Display name | text |
Avatar URL | text |
Name | text |
User type | text |
Email | |
Email verified at | date |
Mobile | text |
Password | object |
Roles | array |
Updated at | date |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Media IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Redacted | boolean |
Uploaded | boolean |
Created at | date |
Updated at | date |
Context | text |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Queue IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
First enter queue at | date |
Queued count | number |
Priority | number |
Item size | number |
Updated at | date |
Modified at | date |
Created at | date |
Relationships | object |
Org | object |
Resource | object |
Queue | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Redacted | boolean |
Relationships | object |
Org | object |
Message | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Type | text |
Published at | date |
Created at | date |
Updated at | date |
Modified at | date |
Changes | object |
Location | text |
Meta | text |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Include | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Sent at | date |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
User mentions | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
From Date | date |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Created at | date |
Created by teams | array |
Assigned users | array |
Assigned teams | array |
Handle at | date |
Handle time | number |
Channels | array |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Klass Name | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Title | text |
Icon | text |
Images | array |
Custom | object |
Tags | array |
Updated at | date |
Created at | date |
Rev | number |
Relationships | object |
Org | object |
Klass | object |
Customer | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Include (comma-separated resources) | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Channel | text |
Body | text |
Payload | object |
Status | text |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Modified by | object |
Conversation | object |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Session IDRequired | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Tracking event | text |
App | text |
Published at | date |
Created at | date |
Location | object |
Meta | object |
Session ID | text |
Real IP | text |
Relationships | object |
Org | object |
Created by | text |
Modified by | text |
Customer | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Status | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Source | object |
Target | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
IncludeRequired | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Sent at | date |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
User mentions | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Filter | object |
Created At Filter | object |
Updated At Filter | object |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ids | array |
Shared external ids | array |
Emails | array |
Shared emails | array |
Phones | array |
Shared phones | array |
Relationships | object |
Org | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Session ID | text |
First event at | date |
Last event at | date |
Count | number |
Relationships | object |
Org | object |
Customer | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
App | text |
Channel | text |
From | object |
To | array |
Body | text |
Payload | object |
Status | text |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Modified by | object |
Conversation | object |
| Field | Type |
|---|---|
Include | text |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Sent at | date |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Pending Invitation | boolean |
Deleted | boolean |
User Type | choice |
Email | |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Display name | text |
Name | text |
User type | text |
Email | |
Mobile | text |
Roles | array |
Updated at | date |
Created at | date |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
User ID | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
Queued count | number |
Priority | number |
Item size | number |
Updated at | date |
Modified at | date |
Created at | date |
Relationships | object |
Org | object |
Resource | object |
Last revision | object |
Assigned to | object |
Accepted by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
First enter queue at | date |
Queued count | number |
Priority | number |
Item size | number |
Ivr | object |
Handle | object |
Relationships | object |
Org | object |
Team | object |
Resource | object |
Work session | object |
Routed to session | object |
Routed to | object |
Last revision | object |
Assigned to | object |
Queue | object |
Accepted by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Queue ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
First enter queue at | date |
Queued count | number |
Priority | number |
Item size | number |
Ivr | object |
Updated at | date |
Relationships | object |
Org | object |
Modified by | object |
Resource | object |
Last revision | object |
Queue | object |
Links | object |
Self | text |
Actions
| Field | Type |
|---|---|
ID | text |
Customer | text |
External ID | text |
Name | text |
Status | choice |
Priority | number |
Created At | date |
Imported At | date |
Direction | choice |
Reply Channel | text |
Tags | array |
Assigned Users | array |
Assigned Teams | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
ID | text |
External ID | text |
Campaign | text |
Name | text |
Status | choice |
Priority (1-5) | number |
Created At | date |
Imported At | date |
Direction | choice |
Reply Channel | text |
Tags | array |
Assigned Users | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
ChannelRequired | choice |
App | choice |
Customer | text |
Status | choice |
Send At | date |
To | array |
From | object |
EmailRequired | text |
Name | text |
Body | text |
Subject | text |
Reply To | text |
Template | text |
Payload (Dynamic Object) | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
App | text |
Channel | text |
Status | text |
From | object |
To | array |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Customer | object |
Conversation | object |
Created by | object |
Modified by | object |
| Field | Type |
|---|---|
Conversation ID | choice |
Message ID | text |
External ID | text |
Conversation ID | choice |
Reference | object |
Message IDRequired | text |
TypeRequired | choice |
ChannelRequired | choice |
Preview | text |
Subject | text |
DirectionRequired | choice |
AppRequired | text |
Size | number |
Related | text |
Status | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Channel | text |
App | text |
Size | number |
Direction | text |
Meta | object |
Status | text |
Sent at | date |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Items | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Name | text |
Company | text |
External ID | text |
Username | text |
Signed Up At | date |
Last Activity At | date |
Last Customer Activity At | date |
Last Seen At | date |
Avatar URL | url |
External IDs | array |
Shared External IDs | array |
Emails | array |
Shared Emails | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ids | array |
Shared external ids | array |
Emails | array |
Shared emails | array |
Phones | array |
Shared phones | array |
Relationships | object |
Org | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Klass NameRequired | text |
Customer | text |
Company | text |
External ID | text |
TitleRequired | text |
Description | text |
Images | array |
Icon | text |
Data (Dynamic Object) | text |
Custom (Dynamic Object) | text |
Tags | array |
Created At | date |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Title | text |
Icon | text |
Images | array |
Custom | object |
Tags | array |
Updated at | date |
Created at | date |
Rev | number |
Relationships | object |
Org | object |
Klass | object |
Customer | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Channel Type | choice |
Email | object |
SMS | object |
Whatsapp (Basic Message) | object |
Whatsapp (Interactive) | object |
Whatsapp (Template) | object |
chat | object |
Facebook | object |
Twitter Tweet | object |
Twitter DM | object |
Note | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Channel | text |
Status | text |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Modified by | object |
| Field | Type |
|---|---|
SourceRequired | text |
TargetRequired | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Status | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Source | object |
Target | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer ID | choice |
Message ID | text |
External ID | text |
Conversation ID | choice |
Reference | object |
Message IDRequired | choice |
TypeRequired | choice |
ChannelRequired | choice |
Preview | text |
Subject | text |
DirectionRequired | choice |
AppRequired | text |
Size | number |
Related | text |
Status | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Channel | text |
App | text |
Size | number |
Direction | text |
Meta | object |
Status | text |
Sent at | date |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Message ID | text |
External ID | text |
Customer Name | text |
Conversation ID | choice |
Reference | object |
Message IDRequired | choice |
TypeRequired | choice |
ChannelRequired | choice |
Preview | text |
Subject | text |
DirectionRequired | choice |
AppRequired | text |
Size | number |
Related | text |
Status | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Channel | text |
App | text |
Size | text |
Direction | text |
Preview | text |
Subject | text |
Meta | text |
Status | text |
Sent at | text |
Created at | text |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
NameRequired | text |
Content TypeRequired | text |
Content LengthRequired | number |
Content (string)Required | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Uploaded | boolean |
Redacted | boolean |
Relationships | object |
Org | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
ID | text |
External ID | text |
BodyRequired | text |
User Mentions | array |
Created At | date |
Modified At | date |
Created By | choice |
Modified By | choice |
Language | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
External ID | text |
Created at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
User mentions | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer ID | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Unmasking window | object |
Created at | date |
Updated at | date |
Modified at | date |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Icon | text |
NameRequired | text |
Display Name | text |
Created At | date |
Imported At | date |
Members | array |
External ID | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Team IDRequired | choice |
MembersRequired | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Display Name | text |
Avatar URL | text |
NameRequired | text |
EmailRequired | |
Mobile | text |
Email Signature | text |
User Type | choice |
Role Groups | array |
Roles | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Display name | text |
Avatar URL | text |
Name | text |
User type | text |
Email | |
Mobile | text |
Email signature | text |
Password | object |
Roles | array |
Role groups | array |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
DomainRequired | text |
EmailRequired |
| Field | Type |
|---|---|
ResourceRequired | object |
Resource IDRequired | text |
TypeRequired | choice |
Revision | number |
Created At | date |
Direction | choice |
Channel | text |
Queue | object |
Entered At | date |
Assigned To | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
Queued count | number |
Priority | number |
Item size | number |
Ivr | object |
Handle | object |
Wrap up | object |
Relationships | object |
Org | object |
Resource | object |
Last revision | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversations | array |
ID | text |
Customer | choice |
External ID | text |
Name | text |
Status | choice |
Priority | number |
Created At | date |
Imported At | date |
Direction | choice |
Reply Channel | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Ids | array |
Context | text |
Status | text |
V 2 | boolean |
Payload | object |
Created at | date |
Updated at | date |
Completed | boolean |
Relationships | object |
Org | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customers | array |
Name | text |
Company | text |
External ID | text |
Username | text |
Signed Up At | date |
Last Activity At | date |
Last Customer Activity At | date |
Last Seen At | date |
Avatar URL | url |
External IDs | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Ids | array |
Context | text |
Status | text |
V 2 | boolean |
Payload | object |
Created at | date |
Updated at | date |
Completed | boolean |
Relationships | object |
Org | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
NameRequired | text |
Content TypeRequired | text |
Content Length (max 10,048,576)Required | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Redacted | boolean |
Uploaded | boolean |
Created at | date |
Updated at | date |
Context | text |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Note IDRequired | choice |
| Field | Type |
|---|---|
Customer ID | choice |
| Field | Type |
|---|---|
Team IDRequired | choice |
MembersRequired | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Ids | array |
Conversation IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Ids | array |
Context | text |
Status | text |
V 2 | boolean |
Payload | object |
Created at | date |
Updated at | date |
Completed | boolean |
Relationships | object |
Org | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Items | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Ids | array |
Customer IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Ids | array |
Context | text |
Status | text |
V 2 | boolean |
Payload | object |
Created at | date |
Updated at | date |
Completed | boolean |
Relationships | object |
Org | object |
Created by | object |
Links | object |
Self | text |
| 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 |
|---|---|
Message IDRequired | choice |
Message Type | choice |
Preview | text |
Attachments | array |
Meta | object |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Preview | text |
Meta | text |
Relationships | object |
Org | object |
Created by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Replace (PUT instead of PATCH) | boolean |
External ID | text |
Name | text |
Direction | choice |
Priority (1-5) | number |
Satisfaction (-1 to 1) | number |
Status | choice |
Reply Channel | text |
Sub Status | text |
Snooze | object |
Time | date |
StatusRequired | choice |
Tags | array |
Suggested Shortcuts | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Replace (Full Update) | boolean |
Name | text |
Company | text |
External ID | text |
Username | text |
Signed Up At | date |
Last Activity At | date |
Last Customer Activity At | date |
Last Seen At | date |
Avatar URL | url |
External IDs | array |
Shared External IDs | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ID | text |
External ids | array |
Shared external ids | array |
Signed up at | text |
Avatar URL | text |
Username | text |
Relationships | object |
Org | object |
Messages | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Media Object IDRequired | text |
Name | text |
Redacted | boolean |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Redacted | boolean |
Uploaded | boolean |
Created at | date |
Updated at | date |
Context | text |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Message ID | choice |
Replace | boolean |
Conversation ID | text |
External ID | text |
Preview | text |
Subject | text |
Status | choice |
Error | object |
Status | number |
Code | text |
Title | text |
Detail | text |
Source (Dynamic Object) | text |
Meta (Dynamic Object) | text |
Links (Dynamic Object) | text |
Error At | date |
Sent At | date |
Size | number |
Attachments | array |
Meta (Dynamic Object) | text |
Custom (Raw JSON) | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Lang | text |
Relationships | object |
Org | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Attachment IDRequired | choice |
Name | text |
Redacted | boolean |
Content Type | text |
Content Length | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Content type | text |
Content length | number |
Uploaded | boolean |
Redacted | boolean |
Relationships | object |
Org | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Note IDRequired | choice |
Replace | boolean |
Conversation IDRequired | choice |
External ID | text |
BodyRequired | text |
User Mentions | array |
Deleted | boolean |
Attachments | array |
Created At | date |
Modified At | date |
Updated At | date |
Created By | choice |
Modified By | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
User mentions | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Team IDRequired | choice |
Icon | text |
Name | text |
Display Name | text |
Members | array |
Created At | date |
Deleted | boolean |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Created at | date |
Updated at | date |
Modified at | date |
Members | array |
Relationships | object |
Org | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Display Name | text |
Avatar URL | text |
Name | text |
Email | |
Mobile | text |
Email Signature | text |
Deleted | boolean |
Password | text |
Current Password | text |
User Type | choice |
Role Groups | array |
Roles | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Display name | text |
Name | text |
User type | text |
Email | |
Mobile | text |
Email signature | text |
Password | object |
Roles | array |
Role groups | text |
Updated at | date |
Relationships | object |
Org | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Work Item IDRequired | choice |
Queue | object |
Queue IDRequired | choice |
Key | text |
Entered At | date |
Routed | object |
Accepted | object |
Resource | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Resource type | text |
Status | text |
Paused | boolean |
Channel | text |
First enter queue at | date |
Queued count | number |
Priority | number |
Item size | number |
Ivr | object |
Updated at | date |
Relationships | object |
Org | object |
Resource | object |
Last revision | object |
Queue | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Conversation IDRequired | choice |
External ID | text |
Name | text |
Direction | choice |
Priority (1-5) | number |
Satisfaction (-1 to 1) | number |
Status | choice |
Reply Channel | text |
Sub Status | text |
Snooze | object |
Time | date |
StatusRequired | choice |
Tags | array |
Suggested Shortcuts | array |
Suggested Tags | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Channels | array |
Status | text |
Message count | number |
Note count | number |
Satisfaction | number |
Created at | date |
Updated at | date |
Modified at | date |
Tags | array |
Relationships | object |
Org | object |
Customer | object |
Messages | object |
Created by | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Ids | array |
Conversation IDRequired | choice |
Object Type | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Ids | array |
Context | text |
Status | text |
V 2 | boolean |
Payload | object |
Created at | date |
Updated at | date |
Completed | boolean |
Relationships | object |
Org | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Name | text |
Company | text |
External ID | text |
Username | text |
Signed Up At | date |
Last Activity At | date |
Last Customer Activity At | date |
Last Seen At | date |
Avatar URL | url |
External IDs | array |
Shared External IDs | array |
Emails | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Display name | text |
Display color | text |
Display icon | text |
External ID | text |
External ids | array |
Shared external ids | array |
Signed up at | date |
Avatar URL | text |
Username | text |
Relationships | object |
Org | object |
Messages | object |
Modified by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Customers | array |
Customer IDRequired | choice |
Replace (Full Update) | boolean |
Name | text |
Company | text |
External ID | text |
Username | text |
Signed Up At | date |
Last Activity At | date |
Last Customer Activity At | date |
Last Seen At | date |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Ids | array |
Context | text |
Status | text |
V 2 | boolean |
Payload | object |
Created at | date |
Updated at | date |
Completed | boolean |
Relationships | object |
Org | object |
Created by | object |
Links | object |
Self | text |
| Field | Type |
|---|---|
Message IDRequired | choice |
Conversation ID | choice |
External ID | text |
Preview | text |
Subject | text |
Status | choice |
Error | object |
Status | number |
Code | text |
Title | text |
Detail | text |
Source (Dynamic Object) | text |
Meta (Dynamic Object) | text |
Links (Dynamic Object) | text |
Error At | date |
Sent At | date |
Size | number |
Attachments | array |
Meta (Dynamic Object) | text |
Custom (Raw JSON) | text |
Related | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
External ID | text |
Channel | text |
App | text |
Size | number |
Direction | text |
Preview | text |
Sentiment | object |
Meta | object |
Status | text |
Lang | text |
Relationships | object |
Org | object |
Modified by | object |
Customer | object |
Conversation | object |
Links | object |
Self | text |
Related | text |
| Field | Type |
|---|---|
Note IDRequired | choice |
Conversation ID | choice |
External ID | text |
Body (1-10240 chars) | text |
User Mentions | array |
Deleted | boolean |
Attachments | array |
Created At | date |
Modified At | date |
Updated At | date |
Created By | choice |
Modified By | choice |
Language | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Body | text |
Created at | date |
Updated at | date |
Relationships | object |
Org | object |
Customer | object |
Created by | object |
Conversation | object |
User mentions | object |
Links | object |
Self | text |



