ChatWoot

Interact with ChatWoot API

Actions113

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

Overview

This node operation allows you to add a new Help Center portal to a specified account in the ChatWoot platform. It is useful for organizations that want to create and manage multiple help center portals, each potentially customized with different branding, locales, and configurations. For example, a company could use this node to programmatically create a new customer support portal tailored for a specific region or product line.

Properties

Name	Meaning
Account Id	The numeric ID of the account where the new help center portal will be created.
Archived	Boolean flag indicating whether the portal is archived (not live) or active (live).
Color	Header color for the help center, specified as a HEX color string (e.g., "#ffffff").
Config	JSON configuration object specifying supported locales and default locale for the portal.
Custom Domain	Custom domain URL to display the help center under a branded web address.
Header Text	Text displayed in the header of the help center.
Homepage Link	URL link to the main dashboard or homepage associated with the portal.
Name	Name of the new help center portal.
Slug	URL slug used in the portal's link for easy access.
Page Title	Title of the page shown in the browser tab or window for the portal.

Output

The node outputs JSON data representing the newly created help center portal. This typically includes details such as the portal's ID, name, status, configuration, URLs, and other metadata returned by the ChatWoot API after successful creation. There is no binary data 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 the ChatWoot REST API endpoint to create the help center portal.

Troubleshooting

Common issues:
- Invalid or missing Account Id can cause the API call to fail.
- Incorrectly formatted JSON in the Config property may result in parsing errors.
- Providing an invalid custom domain URL or slug might cause validation errors from the API.
- Network connectivity or authentication failures due to incorrect API credentials.
Error messages:
- "Unauthorized" or "Authentication failed": Check that the API key credential is valid and has necessary permissions.
- "Invalid input" or "Bad request": Verify all required properties are provided and correctly formatted, especially JSON fields.
- "Resource not found": Confirm the Account Id exists in the ChatWoot system.