Overview
This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations on CRM data such as creating records, deleting records, describing modules, listing available types, querying data, retrieving specific records, and updating existing records. It is useful for automating CRM workflows, synchronizing data between systems, or managing CRM entities programmatically.
For the Describe operation specifically, the node fetches metadata about a specified module in Vtiger CRM. This includes details about the fields, their types, and other structural information of that module. This operation is beneficial when you want to understand the schema of a module before performing further actions like creating or updating records.
Practical Example
- You want to dynamically generate forms or UI elements based on the fields available in a Vtiger module.
- Before importing data into a module, you retrieve its description to validate field names and types.
- Automate documentation or auditing of your CRM schema by extracting module descriptions regularly.
Properties
| Name | Meaning |
|---|---|
| Module | Exact module name (case sensitive). Specifies which Vtiger CRM module to describe. |
Output
The output is a JSON object containing the response from the Vtiger CRM API's describe operation. This typically includes:
- Metadata about the specified module.
- Details about each field in the module such as field names, data types, labels, and other attributes.
- Information necessary to understand the structure and constraints of the module.
The output is returned as an array with one element containing this JSON data.
Dependencies
- Requires access to a Vtiger CRM instance with valid credentials including:
- Host URL of the Vtiger CRM server.
- Username.
- An API access key for authentication.
- The node uses the Vtiger webservice API endpoints (
/webservice.php) for all operations. - Requires n8n credentials configured with these details to authenticate and interact with the Vtiger API.
Troubleshooting
- Authentication errors: If the node fails at the challenge or login step, verify that the host URL, username, and API access key are correct and that the user has API access enabled.
- Module not found: If the describe operation returns an error or empty result, ensure the module name is spelled exactly as it appears in Vtiger (case sensitive).
- Network issues: Ensure the Vtiger server is reachable from the n8n environment and no firewall or proxy blocks the requests.
- Unexpected API errors: Check the error message returned by the API; it may indicate permission issues or invalid parameters.
- JSON parsing errors: When providing JSON input for other operations, ensure the JSON is valid and properly formatted.
Links and References
- Vtiger CRM Official Documentation
- Vtiger Webservice API Reference
- n8n HTTP Request Node Documentation (for understanding underlying HTTP calls)