Actions12
Overview
The node integrates with Vtiger CRM, an open-source customer relationship management system. It allows users to perform various operations on the CRM data via its webservice API. The "List Types" operation specifically retrieves a list of all available entity types in the Vtiger CRM instance.
This node is beneficial for workflows that need to dynamically discover or work with different CRM modules/entities without hardcoding their names. For example, before creating or querying records, you might want to list all available types to present options or validate input.
Practical example:
- Use the "List Types" operation to fetch all CRM modules (like Contacts, Leads, Accounts) and then loop over them to perform batch processing or reporting.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session identifier string obtained from a prior successful login operation. Required to authenticate subsequent requests. |
Output
The output JSON contains the response from the Vtiger CRM API for the "listtypes" operation. This typically includes a list of all entity types (modules) available in the CRM system.
Example structure (simplified):
{
"success": true,
"result": [
"Accounts",
"Contacts",
"Leads",
"Potentials",
...
]
}
success: Boolean indicating if the request was successful.result: An array of strings representing the names of the CRM entity types.
No binary data is output by this operation.
Dependencies
- Requires connection credentials to a Vtiger CRM instance, including host URL, username, and access key.
- The node uses HTTP requests to communicate with the Vtiger webservice API endpoint
/webservice.php. - The user must first perform a login operation to obtain a valid session name used in this operation.
- No additional external services or environment variables are required beyond the configured Vtiger CRM credentials.
Troubleshooting
- Invalid or expired session: If the session name is invalid or expired, the API will return an error. Ensure you perform a fresh login operation to get a valid session name before calling "List Types".
- Network or host errors: Verify the Vtiger host URL is correct and accessible from n8n.
- API errors: The node throws errors if the API returns failure responses. Check the error message for details.
- Operation not implemented: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if called.