Requirements
To use Kustomer on WEXTL you need an active account and an API access token from your account settings.[3]
Get your Kustomer credentials
Connect Kustomer in WEXTL
- Log in to your WEXTL account, add the Kustomer node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Kustomer account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Kustomer node modules
The list below is a reference of every Kustomer node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Kustomer node module below to inspect its input parameters, outputs, and connection requirements.
Watch ConversationsTrigger
| 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 |
Watch CustomersTrigger
| 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 |
Watch MessagesTrigger
| 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 |
Watch NotesTrigger
| 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 |
Watch TeamsTrigger
| 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 |
Watch UsersTrigger
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Display name | text |
| Avatar URL | text |
| Name | text |
| User type | text |
| Mobile | text |
| Email signature | text |
| Password | object |
| Roles | array |
| Role groups | array |
| Relationships | object |
| Org | object |
| Links | object |
| Self | text |
Watch WorkItemsTrigger
| 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 |
Get a ConversationAction
| 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 |
Get a Conversation by External IDAction
| 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 |
Get a CustomerAction
| 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 |
Get a Customer by EmailAction
| 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 |
Get a Customer by External IDAction
| 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 |
Get a Customer by Phone NumberAction
| 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 |
Get a Customer EventAction
| 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 |
Get a Customer MergeAction
Get a MessageAction
| Field | Type |
|---|---|
Message IDRequired | choice |
| Sent At | date |
| Error At | date |
| Created At | date |
| Imported At | date |
| Modified At | date |
| 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 |
Get a Message AttachmentAction
Get a Message by External IDAction
| 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 |
Get a NoteAction
Get a Work ItemAction
| 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 |
Get an AttachmentAction
Get Conversation TimesAction
| 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 |
Get Current UserAction
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Display name | text |
| Avatar URL | text |
| Name | text |
| User type | text |
| Email verified at | date |
| Mobile | text |
| Password | object |
| Roles | array |
| Updated at | date |
| Relationships | object |
| Org | object |
| Links | object |
| Self | text |
Get MediaAction
Get the Next Work Item in a QueueAction
| 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 |
List Conversation AttachmentsSearch
List Conversation EventsSearch
| 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 |
List Conversation MessagesSearch
| 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 |
List Conversation NotesSearch
List Conversation TimesSearch
| 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 |
List ConversationsSearch
| 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 |
List ConversationsSearch
| Field | Type |
|---|---|
Customer IDRequired | choice |
| From Date | date |
| Limit | number |
| Sort | text |
| 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 |
List Customer Custom ObjectsSearch
List Customer DraftsSearch
| 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 |
List Customer EventsSearch
| Field | Type |
|---|---|
Customer IDRequired | choice |
Session IDRequired | text |
| Limit | number |
| Include | text |
| 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 |
List Customer MergesSearch
List Customer MessagesSearch
| 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 |
List Customer NotesSearch
List Customer SessionsSearch
List CustomersSearch
| 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 |
List ForwardsSearch
| 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 |
List MessagesSearch
| 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 |
List NotesSearch
| 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 |
List TeamsSearch
List User TeamsSearch
List UsersSearch
List Work ItemsSearch
| 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 |
List Work Items in a ConversationSearch
| 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 |
List Work Items in QueueSearch
| 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 |
Create a ConversationAction
| 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 |
Create a ConversationAction
| 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 |
Create a Conversation ForwardAction
| 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 |
Create a Conversation MessageAction
| 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 |
Create a Conversation TagAction
| 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 |
Create a CustomerAction
| 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 |
Create a Customer Custom ObjectAction
| 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 |
Create a Customer DraftAction
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Channel Type | choice |
| object | |
| SMS | object |
| Whatsapp (Basic Message) | object |
| Whatsapp (Interactive) | object |
| Whatsapp (Template) | object |
| chat | object |
| 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 |
Create a Customer MergeAction
Create a Customer MessageAction
| 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 |
Create a MessageAction
| 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 |
Create a NoteAction
| 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 |
Create a TeamAction
| 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 |
Create a Team MemberAction
Create a UserAction
| 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 |
| Mobile | text |
| Email signature | text |
| Password | object |
| Roles | array |
| Role groups | array |
| Relationships | object |
| Org | object |
| Links | object |
| Self | text |
Create a User Password ResetAction
| Field | Type |
|---|---|
DomainRequired | text |
EmailRequired |
Create a Work ItemAction
| 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 |
Create an AttachmentAction
| 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 |
Create an Unmasking WindowAction
Create ConversationsAction
| 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 |
Create CustomersAction
| 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 |
Create MediaAction
| 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 |
Delete a ConversationAction
| Field | Type |
|---|---|
Conversation IDRequired | choice |
Delete a CustomerAction
| Field | Type |
|---|---|
Customer IDRequired | choice |
Delete a NoteAction
| Field | Type |
|---|---|
Note IDRequired | choice |
Delete a Team MemberAction
Delete an Unmasking WindowAction
| Field | Type |
|---|---|
| Customer ID | choice |
Delete Conversation TagsAction
| 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 |
Delete ConversationsAction
Delete CustomersAction
Make an API Calluniversal
Redact a MessageAction
Update a ConversationAction
| 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 |
Update a CustomerAction
| 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 |
Update a MediaAction
Update a MessageAction
| 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 |
Update a NoteAction
| 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 |
Update a TeamAction
| 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 |
Update a UserAction
| Field | Type |
|---|---|
| Display Name | text |
| Avatar URL | text |
| Name | text |
| 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 |
| Mobile | text |
| Email signature | text |
| Password | object |
| Roles | array |
| Role groups | text |
| Updated at | date |
| Relationships | object |
| Org | object |
| Links | object |
| Self | text |
Update a Work ItemAction
| 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 |
Update an AttachmentAction
Update Conversation AttributesAction
| 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 |
Update ConversationsAction
Update Customer AttributesAction
| 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 |
Update CustomersAction
| 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 |
Update Message AttributesAction
| 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 |
Update Note AttributesAction
| 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 |
Templates
Look for Kustomer templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Chatling[2]AI customer-service agent for chatbot contacts and conversations.
- DeskproAI-powered help desk for tickets, knowledge base, and customer support workflows.
- BoldDeskCustomer support help desk platform for managing tickets, live chat, contacts, and approval workflows.
- CapacityAI-powered support automation platform that deflects tickets by answering questions, routing requests, and managing knowledge across teams.
- CharlaAI chatbot and live-chat platform for contacts, articles, and conversations.
References
- WEXTL® Kustomer Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Kustomer.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:11
