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
Contacts API → Create A Contact
AI-generatedOverview
This node allows you to create a new contact in the Contacts API of ChatWoot. It is useful for scenarios where you want to programmatically add customer or user information into your ChatWoot inbox, such as when integrating with CRM systems, lead capture forms, or other customer data sources. For example, after a user submits a signup form on your website, you can use this node to automatically create a contact record in ChatWoot to start engaging with them via chat.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The identifier obtained from the API inbox channel where the contact will be created. |
| Identifier | External identifier of the contact (e.g., user ID from another system). |
| Identifier Hash | A hash of the identifier prepared for HMAC authentication purposes. |
| Email address of the contact. | |
| Name | Full name of the contact. |
| Phone Number | Contact's phone number. |
| Avatar Url | URL pointing to an image file (jpeg, png) to be used as the contact's avatar. |
| Custom Attributes | JSON object containing any custom attributes related to the contact (e.g., preferences). |
Output
The node outputs JSON data representing the newly created contact as returned by the ChatWoot API. This typically includes fields such as the contact's unique ID within ChatWoot, their email, name, phone number, avatar URL, and any custom attributes set. The output does not include binary data.
Dependencies
- Requires an active ChatWoot account with API access.
- Needs an API key credential configured in n8n for authenticating requests to the ChatWoot API.
- The base URL of the ChatWoot instance must be provided in the credentials configuration.
Troubleshooting
- Missing or invalid Inbox Identifier: The node requires a valid inbox identifier to create a contact. Ensure that the inbox ID is correct and accessible via the API key used.
- Authentication errors: If the API key or base URL is incorrect or expired, the node will fail to authenticate. Verify credentials and permissions.
- Invalid JSON in Custom Attributes: The
custom_attributesfield expects valid JSON. Malformed JSON will cause errors; ensure proper formatting. - Network issues: Connectivity problems between n8n and the ChatWoot server can cause timeouts or failures.
- API rate limits: Excessive requests may trigger rate limiting by ChatWoot, resulting in errors.