Actions113
- 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
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- 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
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.
- Associating a custom domain with the help center portal for branding purposes.
For example, a company launching a new product line can use this node to quickly spin up a help center portal tailored to that product, complete with its own URL slug, color scheme, and supported languages.
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 to display the help center under (e.g., "https://chatwoot.help/"). |
| Header Text | Text to display in the header of the help center. |
| Homepage Link | URL link to the main dashboard or homepage associated with the help center. |
| Name | Name of the new help center portal. |
| Slug | URL-friendly slug for the portal, used in the portal's web address. |
| 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, slug, configuration, status, and URLs. The output can be used downstream in workflows to reference the created portal or to perform further operations like updating or deleting it.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The node uses the ChatWoot API base URL configured in the credentials.
- Proper permissions on the ChatWoot account are necessary to create help center portals.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will likely return an error. Verify the account ID before running the node.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
- Malformed Config JSON: The
configproperty expects valid JSON. Invalid JSON syntax will cause errors. Use proper JSON formatting. - Slug Conflicts: If the slug is already in use by another portal, the API may reject the request. Choose unique slugs.
- Network Issues: Connectivity problems with the ChatWoot API endpoint will cause failures. Check network access and API availability.