Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger CRM data. It supports actions such as creating records, describing modules, querying data, retrieving records, updating entries, managing relations, and uploading documents.
A common use case is automating CRM workflows, for example:
- Automatically creating new leads or contacts from form submissions.
- Retrieving metadata about a module’s fields to dynamically build forms or validate data.
- Querying records based on specific criteria to generate reports or trigger follow-up actions.
- Uploading documents related to CRM entities directly from other systems.
The "Describe" operation specifically fetches metadata about a given module, which helps understand the structure and available fields of that module.
Properties
| Name | Meaning |
|---|---|
| Module | Exact module name (case sensitive). Specifies the Vtiger CRM module to describe. |
Output
The output is a JSON object representing the response from the Vtiger API for the "describe" operation. This typically includes metadata about the specified module, such as its fields, field types, labels, and other configuration details.
Example output structure (simplified):
{
"success": true,
"result": {
"moduleName": "Contacts",
"fields": [
{
"name": "firstname",
"label": "First Name",
"type": "string",
...
},
...
]
}
}
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Vtiger CRM instance.
- The node makes HTTP requests to the Vtiger webservice endpoint (
/webservice.php). - The user must configure credentials with the host URL, username, and access key for their Vtiger CRM.
Troubleshooting
- Authentication errors: If the node fails at the login step, verify that the API credentials (host, username, access key) are correct and that the Vtiger instance is reachable.
- Module not found: If the "describe" operation returns an error or empty result, ensure the module name is spelled exactly as in Vtiger (case sensitive).
- Network issues: Timeouts or connection errors indicate network problems or incorrect host URL.
- Unexpected API errors: Check the error message returned by the API; it may indicate permission issues or unsupported operations.