Actions12
Overview
This node integrates with Vtiger CRM (an open-source customer relationship management system) to perform various operations via its webservice API. Specifically, the Query operation allows users to run custom queries against the Vtiger database using the Vtiger Query Language (similar to SQL). This is useful for retrieving filtered or specific data sets from the CRM, such as lists of contacts, accounts, or other entities based on complex criteria.
Common scenarios include:
- Extracting records that meet certain conditions (e.g., all leads created in the last month).
- Fetching related records by joining tables.
- Running reports or analytics queries directly within an n8n workflow.
Example: A user might query all active deals worth over $10,000 to trigger follow-up emails or update dashboards.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session identifier string obtained from a prior Login operation; required for authentication in subsequent requests. |
| Query | The Vtiger Query Language statement to execute. This should be a valid query string to fetch desired data. |
Output
The node outputs the JSON response returned by the Vtiger CRM API for the executed query. This typically includes:
success: Boolean indicating if the query was successful.result: An array of objects representing the queried records matching the query criteria.- Other metadata fields depending on the API response.
No binary data output is produced by this operation.
Dependencies
- Requires a configured API credential containing the Vtiger host URL, username, and access key.
- The node uses HTTP requests to communicate with the Vtiger webservice endpoint
/webservice.php. - The session name must be obtained beforehand via the Login operation to authenticate requests.
Troubleshooting
- Invalid Session Name: If the session name is missing, expired, or invalid, the API will reject the query. Ensure you have successfully logged in and are passing the correct session token.
- Malformed Query: Syntax errors in the query string will cause the API to return an error. Validate your query syntax according to Vtiger's query language rules.
- API Connection Issues: Network problems or incorrect host URLs can cause request failures. Verify the API endpoint and network connectivity.
- Unimplemented Operations: Some operations like "extend_session" or "logout" are not implemented and will throw errors if used.