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
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Overview
This node operation allows you to add a new Help Center portal to an existing 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 specific product or region.
- Setting up multilingual support by configuring allowed locales.
- Customizing the look and feel of the help center with colors and header text.
- Linking the portal to a custom domain or homepage URL.
For example, a company could use this node to programmatically create a new help center portal for their Spanish-speaking customers with a custom domain and localized content.
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 specifying supported locales and default locale for the portal. |
| Custom Domain | Custom domain URL where the help center will be accessible. |
| Header Text | Text displayed in the header of the help center. |
| Homepage Link | URL linking back to the main dashboard or homepage from the help center. |
| Name | Name of the new help center portal. |
| Slug | URL-friendly slug used in the portal's link. |
| 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, URL, status, and configuration settings. The output can be used downstream in workflows to reference the new portal or trigger further actions.
There is no indication that this node outputs binary data.
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 call will fail. 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 a valid JSON string. Invalid JSON will cause parsing errors. Use proper JSON formatting. - Missing Required Fields: The
account_idandnamefields are required. Omitting them will result in errors. - Custom Domain Issues: If the custom domain is not properly configured or verified on the ChatWoot side, the portal may not be accessible.