ChatWoot

Interact with ChatWoot API

Actions113

Account Agent Bots Actions
- List All Account Agent Bots
- Create An Account Agent Bot
- Get Details Of A Single Account Agent Bot
- Delete An Account Agent Bot
- Update An Account Agent Bot
Agents Actions
- Get Account Agents
- Add New Agent To Account
- Delete Agent From Account
- Update Agent In Account
Canned Responses Actions
- Get Account Canned Response
- Add New Canned Response To Account
- Delete Canned Response From Account
Canned Response Actions
- Update Canned Response In Account
Custom Attributes Actions
- Get Account Custom Attribute
- Add New Custom Attribute To Account
- Get Details Of A Single Custom Attribute
- Delete Custom Attribute From Account
- Update Custom Attribute In Account
Contacts Actions
- Contact List
- Contact Create
- Contact Details
- Contact Update
- Contact Delete
- Contact Conversations
- Contact Search
- Contact Filter
Contact Actions
- Contact Inbox Creation
- Contactable Inboxes Get
Automation Rule Actions
- Get Account Automation Rule
- Add New Automation Rule To Account
- Get Details Of A Single Automation Rule
- Delete Automation Rule From Account
- Update Automation Rule In Account
Help Center Actions
- Get Portal
- Add New Portal To Account
- Update New Portal To Account
- Add New Category To Account
- Add New Article To Account
Conversations Actions
- Conversation List Meta
- Conversation List
- New Conversation
- Conversation Filter
- Get Details Of A Conversation
- Toggle Status Of A Conversation
- Toggle Priority Of A Conversation
Conversation Assignment Actions
- Assign A Conversation
Conversation Labels Actions
- List All Labels Of A Conversation
- Conversation Add Labels
Inboxes Actions
- List All Inboxes
- Get Inbox
- Inbox Creation
- Update Inbox
- Get Inbox Agent Bot
- Update Agent Bot
- Get Inbox Members
- Add New Agent To Inbox
- Delete Agent In Inbox
- Update Agents In Inbox
Messages Actions
- List All Messages
- Create A New Message In A Conversation
- Delete A Message
Integrations Actions
- Get Details Of All Integrations
- Create An Integration Hook
- Delete An Integration Hook
- Update An Integrations Hook
Teams Actions
- List All Teams
- Create A Team
- Get Details Of A Single Team
- Delete A Team
- Update A Team
- Get Team Members
- Add New Agent To Team
- Delete Agent In Team
- Update Agents In Team
Custom Filters Actions
- List All Filters
- Create A Custom Filter
- Get Details Of A Single Custom Filter
- Delete A Custom Filter
- Update A Custom Filter
Webhooks Actions
- List All Webhooks
- Create A Webhook
- Delete A Webhook
- Update A Webhook
Reports Actions
- List All Conversation Statistics
- List All Conversation Statistics Summary
- Get Account Conversation Metrics
- Get Agent Conversation Metrics
Accounts Actions
- Create An Account
- Get Details Of An Account
- Delete An Account
- Update An Account
Account Users Actions
- List All Account Users
- Create An Account User
- Delete An Account User
Agent Bots Actions
- Create An Agent Bot
- Get Details Of A Single Agent Bot
- Delete An Agent Bot
- Update An Agent Bot
Users Actions
- Create A User
- Get Details Of A User
- Delete A User
- Update A User
- Get Sso Url Of A User
Inbox API Actions
- Get Details Of A Inbox
Contacts API Actions
- Create A Contact
- Get Details Of A Contact
- Update A Contact
Conversations API Actions
- List All Contact Conversations
- Create A Conversation
Messages API Actions
- List All Converation Messages
- Create A Message
- Update A Message
CSAT Survey Page Actions
- Get Csat Survey Page

Overview

This node allows you to create a new conversation in the ChatWoot platform. It is useful for automating customer support workflows by programmatically opening conversations linked to specific accounts, inboxes, and contacts. For example, you can use this node to start a conversation when a user submits a form on your website or when an event triggers a support ticket creation.

Properties

Name	Meaning
Account Id	The numeric ID of the account under which the conversation will be created.
Source Id	The source identifier of the conversation (e.g., a unique external reference).
Inbox Id	The ID of the inbox where the conversation is created. Allowed types include Website, Phone, API, Email.
Contact Id	The contact's ID for whom the conversation is created.
Additional Attributes	JSON object specifying extra attributes like browser information.
Custom Attributes	JSON object for saving custom key-value pairs as attributes related to the conversation.
Status	The status of the conversation; options are Open, Resolved, or Pending.
Assignee Id	The agent ID to whom the conversation should be assigned.
Team Id	The team ID to assign the conversation to a specific team.
Message	JSON object representing the initial message sent to the conversation, including template parameters.

Output

The node outputs JSON data representing the newly created conversation object returned by the ChatWoot API. This typically includes details such as conversation ID, status, timestamps, assigned agents or teams, and any messages associated with the conversation. There is no binary output.

Dependencies

Requires an API key credential for authenticating with the ChatWoot API.
The base URL for the ChatWoot instance must be configured in the node credentials.
The node uses HTTP requests to interact with the ChatWoot REST API.

Troubleshooting

Missing required fields: Ensure that Account Id, Source Id, and Inbox Id are provided as they are mandatory.
Invalid JSON in Additional or Custom Attributes: These fields expect valid JSON strings; invalid JSON will cause errors.
Authentication errors: Verify that the API key credential and base URL are correctly set up.
Permission issues: The API key used must have permissions to create conversations and assign agents or teams.
Status value errors: Only "open", "resolved", or "pending" are accepted for the status field.

Links and References

ChatWoot API Documentation - Official API docs for more details on conversation creation and attributes.
n8n Documentation - General guidance on using n8n nodes and credentials.

ChatWootInstall