Overview
This node integrates with Vtiger CRM (an open-source customer relationship management system) to perform various operations on CRM data. Specifically, the Create operation allows users to add new records to a specified module in Vtiger by providing the module name and the record data as JSON.
Common scenarios where this node is beneficial include:
- Automating the creation of leads, contacts, or other entities in Vtiger from external sources.
- Integrating form submissions or other data streams directly into Vtiger CRM.
- Building workflows that enrich CRM data by programmatically adding new entries.
For example, you could use this node to create a new "Leads" record by specifying "Leads" as the module and passing a JSON object with lead details such as name, email, and phone number.
Properties
| Name | Meaning |
|---|---|
| Module | Exact module name in Vtiger where the record will be created (case sensitive). |
| Body | JSON structure representing the fields and values for the new record to be created. |
Output
The node outputs a JSON array containing the response from the Vtiger API after attempting to create the record. This response typically includes success status, the ID of the newly created entity, and any additional metadata returned by Vtiger.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a Vtiger CRM instance.
- Needs credentials including the host URL, username, and an API access key for authentication.
- The node uses Vtiger's webservice API endpoints (
/webservice.php) for all operations. - The node performs a challenge-response login mechanism using MD5 hashing of a token combined with the access key.
Troubleshooting
- Authentication errors: If the node fails during the login challenge step, verify that the provided credentials (host, username, API key) are correct and that the Vtiger instance is accessible.
- Invalid module name: The "Module" property must exactly match the module name in Vtiger (case sensitive). Using an incorrect module name will cause the API to return an error.
- Malformed JSON body: The "Body" property must be valid JSON with field names and values matching the expected schema of the target module. Invalid JSON or unsupported fields may cause the create operation to fail.
- API errors: Any error messages returned by the Vtiger API are surfaced by the node. Review these messages for clues about missing required fields or permission issues.
- Network issues: Ensure the Vtiger server is reachable from the n8n environment.
Links and References
- Vtiger CRM Official Website
- Vtiger Webservice API Documentation
- MD5 Hashing Algorithm (used for authentication token generation)