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 agent to a specified account in the ChatWoot system. It is useful for automating the management of support agents by programmatically creating agent profiles with their details such as name, email, role, and availability status. Practical scenarios include onboarding new customer support staff or synchronizing agent data from an external HR system into ChatWoot.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the new agent will be added. |
| Name | Full name of the agent being added. |
| Email address of the agent. | |
| Role | The role assigned to the agent; options are "Agent" or "Administrator". |
| Availability Status | The current availability setting of the agent; options are "Available", "Busy", or "Offline". |
| Auto Offline | Boolean flag indicating if the agent's availability should automatically switch to offline when away. |
Output
The node outputs JSON data representing the newly created agent object returned by the ChatWoot API. This typically includes the agent’s unique identifier, name, email, role, availability status, and other metadata confirming successful creation. There is no binary 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 for creating agents under a specific account.
Troubleshooting
- Common issues:
- Invalid or missing account ID can cause the API call to fail.
- Providing an email already associated with another agent may result in a conflict error.
- Incorrect API credentials or base URL configuration will lead to authentication errors.
- Error messages:
- "Unauthorized" or "Authentication failed": Check that the API key and base URL are correctly set.
- "Account not found": Verify the account ID exists in ChatWoot.
- "Email already taken": Use a unique email address for the new agent.
Resolving these usually involves verifying input parameters and ensuring proper API access rights.
Links and References
- ChatWoot API Documentation (for detailed API endpoints and payloads)
- n8n documentation on creating custom nodes