Chatwoot

Open-source customer engagement platform for shared inboxes, live chat, and support workflows.

1 trigger10 searches17 actionsInstant (webhooks)Auth: API key

AI-assisted documentation12 min read

This documentation is compiled from our integration source code, internal specs for Chatwoot, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Chatwoot on WEXTL →

Requirements

Connecting Chatwoot takes an active account plus an API access token from your account settings — no other setup is required.[3]

Get your Chatwoot credentials

Access TokentextRequired
Access token, which can be generated from Profile Settings after logging into your account.
[1]
Account IDtextRequired
The numeric ID of the account.
[1]
EnvironmentselectRequired
Select the environment for Chatwoot.
[1]

Connect Chatwoot in WEXTL

Log in to your WEXTL account, add the Chatwoot node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Chatwoot 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 →

Connecting Chatwoot to WEXTL® — Video slide demonstrates how to integrate Chatwoot in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Chatwoot in the WEXTL visual workflow builder.[4]

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 →

Chatwoot node modules

The list below is a reference of every Chatwoot node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any Chatwoot node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch EventsTrigger

No fields documented.

Get a ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice

Output fields[3]

Field	Type
Payload	object
Additional attributes	object
Availability status	text
Email	email
ID	number
Name	text
Phone number	text
Blocked	boolean
Identifier	text
Thumbnail	text
Custom attributes	object

Get a ConversationAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
ID	number
Messages	array
Account ID	number
UUID	text
Additional attributes	object
Agent last seen at	number
Assignee last seen at	number
Can reply	boolean
Contact last seen at	number
Custom attributes	object
Inbox ID	number
Labels	array
Muted	boolean
Snoozed until	number
Status	text
Created at	number
Updated at	number
Timestamp	text
First reply created at	number
Unread count	number

8other output fields

Get an Account ReportSearch

Input fields[3]

Field	Type
MetricRequired	choice
TypeRequired	choice
ID	text
Since	date
Until	date

Output fields[3]

Field	Type
Value	text
Timestamp	number

Get an InboxAction

Input fields[3]

Field	Type
Inbox IDRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Website URL	url
Channel type	text
Avatar URL	url
Widget color	text
Website token	text
Enable auto assignment	boolean
Web widget script	text
Welcome title	text
Welcome tagline	text
Greeting enabled	boolean
Greeting message	text
Channel ID	number
Working hours enabled	boolean
Enable email collect	boolean
Csat survey enabled	boolean
Auto assignment config	object
Out of office message	text
Working hours	array

13other output fields

List Contact ConversationsSearch

Input fields[3]

Field	Type
Contact IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Messages	array
Account ID	number
UUID	text
Additional attributes	object
Agent last seen at	number
Assignee last seen at	number
Can reply	boolean
Contact last seen at	number
Custom attributes	object
Inbox ID	number
Labels	array
Muted	boolean
Snoozed until	number
Status	text
Created at	number
Updated at	number
Timestamp	text
First reply created at	number
Unread count	number

8other output fields

List ContactsSearch

Input fields[3]

Field	Type
Sort	choice
Limit	number

Output fields[3]

Field	Type
Additional attributes	object
City	text
Country	text
Country code	text
Created at IP	text
Availability status	text
Email	text
ID	number
Name	text
Phone number	text
Blocked	boolean
Identifier	text
Thumbnail	text
Custom attributes	object
Last activity at	number
Created at	number
Contact inboxes	array

List InboxesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Website URL	url
Channel type	text
Avatar URL	url
Widget color	text
Website token	text
Enable auto assignment	boolean
Web widget script	text
Welcome title	text
Welcome tagline	text
Greeting enabled	boolean
Greeting message	text
Channel ID	number
Working hours enabled	boolean
Enable email collect	boolean
Csat survey enabled	boolean
Auto assignment config	object
Out of office message	text
Working hours	array

13other output fields

List MessagesSearch

Input fields[3]

Field	Type
Conversation IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Content	text
Account ID	number
Inbox ID	number
Conversation ID	number
Message type	number
Created at	number
Updated at	number
Private	boolean
Status	text
Source ID	text
Content type	text
Content attributes	object
Sender type	text
Sender ID	number
External source ids	object
Additional attributes	object
Processed message content	text
Sentiment	object
Conversation	object

2other output fields

Search ContactsSearch

Input fields[3]

Field	Type
Search Query	text
Sort	choice
Limit	number

Output fields[3]

Field	Type
Additional attributes	object
City	text
Country	text
Country code	text
Created at IP	text
Availability status	text
Email	text
ID	number
Name	text
Phone number	text
Blocked	boolean
Identifier	text
Thumbnail	text
Custom attributes	object
Last activity at	number
Created at	number
Contact inboxes	array

Search ConversationsSearch

Input fields[3]

Field	Type
Assignee Type	choice
Status	choice
Search Query	text
Inbox ID	choice
Team ID	choice
Labels	array
Label	text
Limit	number

Output fields[3]

Field	Type
ID	number
Messages	array
Account ID	number
UUID	text
Additional attributes	object
Agent last seen at	number
Assignee last seen at	number
Can reply	boolean
Contact last seen at	number
Custom attributes	object
Inbox ID	number
Labels	array
Muted	boolean
Snoozed until	number
Status	text
Created at	number
Updated at	number
Timestamp	text
First reply created at	number
Unread count	number

8other output fields

Add an Agent to an InboxAction

Input fields[3]

Field	Type
Inbox IDRequired	choice
Agent BotRequired	choice

Assign a ConversationAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
Assignee ID	choice
Team ID	choice

Create a ContactAction

Input fields[3]

Field	Type
Inbox IDRequired	choice
Name	text
Email	email
Blocked	boolean
Phone Number	text
Avatar	text
Avatar URL	url
Identifier	text
Additional Attributes	array
KeyRequired	text
Value	text
Additional Attributes	array
KeyRequired	choice
Value	text

Output fields[3]

Field	Type
Payload	array
Contact ID	number
Availability status	text

Create a ConversationAction

Input fields[3]

Field	Type
Source IDRequired	text
Inbox IDRequired	choice
Contact ID	number
Additional Attributes	array
KeyRequired	text
Value	text
Additional Attributes	array
KeyRequired	choice
Value	text
Status	choice
Assignee ID	number
Team ID	number
Snoozed Until	date
Message	object
Message ContentRequired	text
Template Params	object

Output fields[3]

Field	Type
ID	number
Account ID	number
Inbox ID	number

Create a MessageAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
ContentRequired	text
Template Parameters	object
NameRequired	text
CategoryRequired	choice
LanguageRequired	text
Processed ParametersRequired	object
Message Type	choice
Private	boolean
Content Type	choice
Content Attributes	array
KeyRequired	text
Value	text
Campaign ID	number

Output fields[3]

Field	Type
ID	number
Content	text
Account ID	number
Inbox ID	number
Conversation ID	number
Message type	number
Created at	number
Updated at	number
Private	boolean
Status	text
Source ID	text
Content type	text
Content attributes	object
Sender type	text
Sender ID	number
External source ids	object
Additional attributes	object
Processed message content	text
Sentiment	object
Conversation	object

2other output fields

Create a UserAction

Input fields[3]

Field	Type
NameRequired	text
Display Name	text
Email	email
Password	text
Additional Attributes	array
KeyRequired	choice
Value	text

Output fields[3]

Field	Type
ID	number
Access token	text
Account ID	number
Available name	text
Avatar URL	text
Confirmed	boolean
Display name	text
Message signature	text
Email	text
Hmac identifier	text
Inviter ID	number
Name	text
Provider	text
Pubsub token	text
Role	text
Ui settings	object
Uid	text
Type	text
Custom attributes	object
Accounts	array

Create an InboxAction

Input fields[3]

Field	Type
NameRequired	text
Avatar	text
Greeting Enabled	boolean
Greeting Message	text
Enable Email Collect	boolean
CSAT Survey Enabled	boolean
Enable Auto Assignment	boolean
Working Hours Enabled	boolean
Out of Office Message	text
Timezone	time
Allow Messages After Resolved	boolean
Lock to Single Conversation	boolean
Portal ID	number
Sender Name Type	choice
Business Name	text
Channel	object
Type	choice
Website URL	url
Welcome Title	text
Welcome Tagline	text
Widget Color	text

Output fields[3]

Field	Type
ID	number
Name	text
Website URL	url
Channel type	text
Avatar URL	url
Widget color	text
Website token	text
Enable auto assignment	boolean
Web widget script	text
Welcome title	text
Welcome tagline	text
Greeting enabled	boolean
Greeting message	text
Channel ID	number
Working hours enabled	boolean
Enable email collect	boolean
Csat survey enabled	boolean
Auto assignment config	object
Out of office message	text
Working hours	array

13other output fields

Delete a ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice

Delete a MessageAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Label a ConversationAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
LabelsRequired	array

Make an API Calluniversal

Input fields[3]

Field	Type
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Update a ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Name	text
Email	email
Blocked	boolean
Phone Number	text
Avatar	text
Avatar URL	url
Identifier	text
Additional Attributes	array
KeyRequired	text
Value	text
Additional Attributes	array
KeyRequired	choice
Value	text

Output fields[3]

Field	Type
Payload	array
Contact ID	number
Availability status	text

Update a ConversationAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
Priority	choice
SLA Policy ID	number

Update a Conversation Custom AttributesAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
PriorityRequired	choice

Update a Conversation PriorityAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
PriorityRequired	choice

Update a Conversation StatusAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
StatusRequired	choice

Update an InboxAction

Input fields[3]

Field	Type
Inbox IDRequired	choice
Name	text
Avatar	text
Greeting Enabled	boolean
Greeting Message	text
Enable Email Collect	boolean
CSAT Survey Enabled	boolean
Enable Auto Assignment	boolean
Working Hours Enabled	boolean
Out of Office Message	text
Timezone	time
Allow Messages After Resolved	boolean
Lock to Single Conversation	boolean
Portal ID	number
Sender Name Type	choice
Business Name	text
Channel	object
Type	choice
Website URL	url
Welcome Title	text
Welcome Tagline	text
Widget Color	text

Output fields[3]

Field	Type
ID	number
Name	text
Website URL	url
Channel type	text
Avatar URL	url
Widget color	text
Website token	text
Enable auto assignment	boolean
Web widget script	text
Welcome title	text
Welcome tagline	text
Greeting enabled	boolean
Greeting message	text
Channel ID	number
Working hours enabled	boolean
Enable email collect	boolean
Csat survey enabled	boolean
Auto assignment config	object
Out of office message	text
Working hours	array

13other output fields

Templates

Look for Chatwoot templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Support category →

References

WEXTL® Chatwoot Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Chatwoot.
WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:39

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.