Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. It allows users to perform various operations such as logging in, listing available types, creating, updating, and querying records within Vtiger CRM.
The "List Types" operation specifically retrieves all the entity types (modules) available in the connected Vtiger CRM instance. This is useful when you want to dynamically discover what kinds of records you can work with, for example, Accounts, Contacts, Leads, or custom modules.
Practical examples:
- Before creating or querying records, use "List Types" to fetch all available modules.
- Dynamically populate dropdowns or UI elements in workflows based on the current CRM schema.
- Validate that a particular module exists before performing further operations.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session ID obtained from a previous successful login operation. Required for this operation to authenticate requests. |
Output
The output is a JSON array containing the response from the Vtiger CRM API's listtypes operation. This typically includes a list of all entity types (modules) available in the CRM instance.
Example structure of the output JSON might look like:
[
{
"success": true,
"result": [
"Accounts",
"Contacts",
"Leads",
"Potentials",
...
]
}
]
No binary data is output by this operation.
Dependencies
- Requires an active Vtiger CRM API connection configured with:
- Host URL of the Vtiger CRM instance.
- Username and access key credentials for authentication.
- The node uses HTTP requests to communicate with the Vtiger CRM webservice endpoint
/webservice.php. - The "List Types" operation requires a valid session name (session ID) obtained from the "Login" operation.
Troubleshooting
Common issues:
- Using an invalid or expired session name will cause the request to fail.
- Incorrect host URL or credentials will prevent successful communication.
- Network connectivity issues may cause timeouts or unreachable errors.
Error messages:
- If the session is invalid or expired, the API may return an error indicating authentication failure. To resolve, perform the "Login" operation again to obtain a fresh session ID.
- Errors related to missing parameters (e.g., session name) will occur if required properties are not set.
- If the node throws an error stating the operation is not implemented, ensure the operation parameter is correctly set to "List Types".