ChatWoot

Interact with ChatWoot API

Actions100

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
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

Overview

This node allows you to create a new Inbox in ChatWoot via its API. Inboxes are channels through which your team can communicate with customers (e.g., email, chat, social media). This node is useful for automating the setup of communication channels when onboarding new teams or accounts, or when programmatically managing multiple customer support channels.

Example scenarios:

Automatically creating a new inbox when a new client account is registered.
Setting up different inboxes for various departments (sales, support, etc.) as part of an onboarding workflow.

Properties

Display Name	Type	Description
Account Id	Number	The numeric ID of the account. Required.
Name	String	The name of the inbox.
Avatar	String	File for avatar image.
Channel	JSON	Channel configuration details.

Output

The output will be a json object containing the details of the newly created inbox as returned by the ChatWoot API. Typical fields may include:

id: Numeric identifier of the inbox.
name: Name of the inbox.
channel_id: Identifier for the associated channel.
avatar_url: URL to the avatar image (if provided).
Other metadata as defined by the ChatWoot API.

Note: The exact structure depends on the ChatWoot API response.

Dependencies

External Service: Requires access to a ChatWoot instance.
API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) and authentication details.
n8n Configuration: Ensure the node has network access to your ChatWoot server.

Troubleshooting

Missing or Invalid Credentials:
Error message: "No credentials found" or authentication errors from the API.
Resolution: Make sure the chatwootApi credential is set up correctly in n8n.
Invalid Account Id:
Error message: "Account not found" or similar from the API.
Resolution: Double-check that the Account Id exists in your ChatWoot instance.
Malformed Channel JSON:
Error message: "Invalid JSON" or parsing errors.
Resolution: Ensure the Channel property contains valid JSON.
Avatar Upload Issues:
Error message: Related to file format or size.
Resolution: Verify the avatar string points to a valid file and meets ChatWoot's requirements.