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 integrates with the Contacts API of ChatWoot to create a new contact within a specified inbox. It is useful for automating the addition of customer or user contact information into ChatWoot, enabling seamless communication and management of contacts in your messaging platform.
Typical use cases include:
- Automatically adding new leads or customers from external systems into ChatWoot.
- Syncing contact details collected from forms or other applications.
- Enriching contact profiles with custom attributes for personalized engagement.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The unique identifier of the inbox channel where the contact will be created (required). |
| Identifier | An external identifier for the contact, useful for linking with other systems. |
| Identifier Hash | A hash value prepared for HMAC authentication related to the contact's identifier. |
| The email address of the contact. | |
| Name | The full name of the contact. |
| Phone Number | The phone number of the contact. |
| Avatar Url | URL pointing to an image file (jpeg, png) to be used as the contact's avatar. |
| Custom Attributes | JSON object containing any additional custom attributes for the contact. |
Output
The node outputs JSON data representing the newly created contact as returned by the ChatWoot API. This typically includes all the contact details stored, such as identifiers, email, name, phone number, avatar URL, and any custom attributes.
If the API supports it, binary data output is not indicated for this operation; the output is purely JSON-based contact information.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The base URL for the ChatWoot instance must be configured in the credentials.
- The node uses the ChatWoot REST API endpoint for creating contacts within a specific inbox.
Troubleshooting
- Missing Inbox Identifier: Since the inbox identifier is required, omitting it will cause the request to fail. Ensure this property is always provided.
- Invalid API Credentials: Authentication errors may occur if the API key or base URL is incorrect or missing. Verify credential configuration.
- Malformed Custom Attributes: The
custom_attributesfield expects valid JSON. Invalid JSON syntax will cause parsing errors. - Network Issues: Connectivity problems with the ChatWoot server can lead to timeouts or failed requests.
- API Rate Limits: Excessive requests might be throttled by the ChatWoot API, resulting in error responses.