Overview
This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations such as creating, updating, deleting, querying, and describing CRM records. Specifically, the Create operation enables users to add new records of a specified type into the Vtiger CRM database.
Common scenarios where this node is beneficial include:
- Automating the creation of leads, contacts, or other entities in Vtiger CRM based on data from other systems.
- Integrating form submissions or external data sources directly into Vtiger without manual entry.
- Streamlining workflows that require dynamic record creation in the CRM.
For example, after capturing a new customer inquiry via a web form, this node can create a corresponding lead record in Vtiger automatically.
Properties
| Name | Meaning |
|---|---|
| Session Name | The active session identifier obtained through a prior login operation; required for authentication in all operations except login. |
| Element Type | The type of CRM entity to create (e.g., Leads, Contacts); specifies which module the new record belongs to. |
| Element | A JSON object representing the data fields and values for the new record to be created in Vtiger CRM. |
Output
The node outputs a JSON object containing the response from the Vtiger CRM API for the create operation. This typically includes details about the newly created record, such as its unique ID and confirmation of success.
No binary data output is produced by this node.
Dependencies
- Requires an active connection to a Vtiger CRM instance, including:
- The host URL of the Vtiger CRM server.
- Valid user credentials (username and access key) configured in n8n credentials.
- The node uses HTTP requests to communicate with the Vtiger webservice API endpoint (
/webservice.php). - For the login operation (not part of Create but relevant for session management), it uses the
crypto-jslibrary to generate MD5 hashes for authentication.
Troubleshooting
- Invalid Session Name: If the session name is missing or expired, API calls will fail. Ensure you have performed a successful login operation beforehand to obtain a valid session name.
- Malformed Element JSON: The "Element" property must be a valid JSON object matching the expected structure for the specified element type. Invalid JSON or missing required fields may cause errors.
- API Connection Issues: Verify that the Vtiger host URL and credentials are correct and that the server is reachable.
- Unsupported Operation Error: Attempting to use an operation not implemented by the node will throw an error indicating the operation is not supported.
- Error Messages from Vtiger API: The node surfaces error messages returned by the Vtiger API, which often include an error message and code. Review these messages to diagnose issues such as permission problems or invalid parameters.