Overview
This node integrates with Vtiger CRM (an open-source customer relationship management system) to perform various operations on CRM data. Specifically, the Query operation allows users to run SQL-like queries against the Vtiger database to retrieve records matching specified criteria.
Common scenarios where this node is beneficial include:
- Extracting filtered lists of leads, contacts, or other entities based on complex conditions.
- Running custom reports or data exports without needing to build them inside Vtiger.
- Integrating Vtiger data into workflows by querying and processing results dynamically.
For example, a user might query all leads with email addresses from a specific domain:
SELECT * FROM Leads WHERE email LIKE '%@domain.com';
This would return all lead records matching that condition for further processing in n8n.
Properties
| Name | Meaning |
|---|---|
| Query | The SQL-like query string to execute against the Vtiger CRM database. Example: SELECT * FROM Leads WHERE email LIKE '%@domain.com'; |
Output
The node outputs a JSON array containing the result of the query operation. The structure corresponds directly to the data returned by Vtiger's API for the executed query, typically an object with success status and a result field holding the queried records.
Example output structure:
[
{
"success": true,
"result": [
{
"id": "12x345",
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@domain.com",
...
},
...
]
}
]
No binary data output is produced by this node.
Dependencies
- Requires connection credentials to a Vtiger CRM instance, including:
- Host URL of the Vtiger server.
- Username.
- An API access key associated with the username.
- The node uses Vtiger's webservice API endpoints (
/webservice.php) for authentication and data operations. - No additional external libraries beyond those bundled with n8n are required.
Troubleshooting
- Authentication errors: If the node fails at the initial challenge or login step, verify that the host URL, username, and API access key are correct and that the Vtiger instance is accessible.
- Invalid query syntax: Since the query property accepts SQL-like statements, malformed queries will cause errors. Ensure the query follows Vtiger's supported syntax.
- Operation not implemented error: This occurs if an unsupported operation value is set. For the Query operation, ensure the operation parameter is exactly
"query". - Entity does not exist: Not applicable for Query but relevant for other operations like Retrieve or Update when referencing IDs.
- Network issues: Check connectivity to the Vtiger server and firewall settings if requests time out or fail.