Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
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 settings such as locale support, branding colors, custom domains, and header text.
Typical use cases include:
- Creating a dedicated help center portal for a new product or service under an existing account.
- Setting up localized help centers supporting multiple languages.
- Customizing the look and feel of the help center by specifying colors, headers, and page titles.
- Linking the help center portal to a custom domain or homepage URL.
For example, a company launching a new product line can use this node to quickly spin up a branded help center portal tailored to that product’s audience.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the new help center portal will be added. |
| 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 defining supported locales and default locale for the portal. |
| Custom Domain | Custom domain URL where the help center will be accessible (e.g., "https://chatwoot.help/"). |
| Header Text | Text displayed in the header of the help center portal. |
| Homepage Link | URL linking back to the main dashboard or homepage from the help center. |
| Name | Name of the help center portal. |
| Slug | URL-friendly slug used in the portal link. |
| Page Title | Title of the help center page shown in the browser tab or window title. |
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.
No binary data output is involved in this operation.
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 for creating help center portals.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to create help center portals.
- Malformed JSON in Config: The
configproperty expects valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting. - Duplicate Slug or Name: If the slug or name already exists for another portal in the same account, the API may reject the request. Choose unique values.
- Network Issues: Connectivity problems with the ChatWoot server will result in request failures. Check network access and base URL correctness.