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
Help Center → Add New Portal To Account
AI-generatedOverview
This node integrates with the ChatWoot API to add a new Help Center portal to a specified account. It allows users to create and configure a help center portal, which can be used to provide customer support documentation, FAQs, and other self-service resources. This is beneficial for organizations looking to centralize their support content and improve customer experience by offering an easily accessible knowledge base.
Practical examples include:
- Creating a branded help center portal for a product or service.
- Setting up multilingual support portals with locale configurations.
- Customizing the appearance and domain of the help center to match company branding.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account where the new portal will be added. |
| Archived | Boolean status indicating if 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 personalized web address. |
| Header Text | Text displayed in the header of the help center portal. |
| Homepage Link | URL link to the main dashboard or homepage associated with the help center. |
| Name | Name of the 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 search results 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, configuration, URLs, status, and other metadata returned by the ChatWoot API after successful creation.
If binary data were involved (e.g., files or images), it would be summarized here, but this operation deals only with JSON data.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in the node credentials.
- Depends on the ChatWoot API being accessible and properly configured to accept requests for creating help center portals.
Troubleshooting
Common Issues:
- Invalid or missing Account Id: Ensure the account ID is correct and exists in ChatWoot.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Malformed JSON in the Config property: Make sure the JSON string is correctly formatted.
- Duplicate slugs or names might cause conflicts; use unique values.
Error Messages:
- 401 Unauthorized: Check API key and authentication settings.
- 400 Bad Request: Review input properties for missing required fields or invalid formats.
- 404 Not Found: The specified account ID does not exist.
- 409 Conflict: The slug or portal name already exists; try a different value.
Resolving these usually involves verifying input parameters, credentials, and API endpoint accessibility.
Links and References
- ChatWoot Official Documentation
- ChatWoot Help Center API Reference
- n8n Documentation on HTTP Request Nodes (for understanding API integrations)