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
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node operation allows you to add a new agent to a specified account within the ChatWoot platform. It is useful for automating the management of support agents by programmatically creating agent profiles with defined roles and availability statuses. Typical use cases include onboarding new customer support staff, synchronizing user data from other systems, or dynamically managing team members in response to business needs.
For example, when a new support hire joins your company, this node can be used to automatically create their agent profile in ChatWoot with their name, email, role (agent or administrator), and availability settings.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account where the 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 status 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 details such as the agent’s unique ID, name, email, role, availability status, and timestamps related to creation. The output can be used downstream in workflows to reference the agent or confirm successful creation.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the ChatWoot API.
- Needs an API authentication token configured in the node credentials to authorize requests.
- The base URL for the ChatWoot instance must be set in the credentials configuration.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
- Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly configured.
- Email Conflicts: Attempting to add an agent with an email already registered may result in errors. Check for duplicates before adding.
- Role Validation: Only "agent" or "administrator" are valid roles. Providing other values will cause request rejection.
- Network Issues: Connectivity problems with the ChatWoot server will prevent the node from completing successfully.
Links and References
- ChatWoot API Documentation - Official API docs for detailed endpoint information.
- ChatWoot Website - For general product information and support.