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 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, synchronizing user data from other HR or CRM systems, or dynamically managing agent roles and statuses based on business rules.
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 as returned by the ChatWoot API. This typically includes the agent’s unique identifier, name, email, role, availability status, and other metadata related to the agent profile. 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 depends on the ChatWoot REST API endpoint that handles agent creation within an account.
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.
- Missing Required Fields: The node requires
Account Id,Name,Email, andRole. Omitting any of these will cause validation errors. - API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to create agents.
- Email Format Issues: Providing an invalid email format may result in API rejection.
- Role Value Errors: Only "agent" or "administrator" are accepted values for the role property.
- Network or API Downtime: Temporary connectivity issues or ChatWoot service outages can cause failures.
Links and References
- ChatWoot API Documentation (for detailed API endpoints and payloads)
- n8n Documentation (for general usage of custom nodes and credentials)