Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. Specifically, the Query operation allows users to execute custom queries against the Vtiger CRM database using its webservice API. This is useful for retrieving specific data sets that are not directly accessible through predefined operations.
Common scenarios include:
- Fetching records based on complex criteria.
- Extracting customized reports or filtered lists of CRM entities.
- Integrating Vtiger data into workflows where dynamic querying is required.
For example, a user might run a query to retrieve all contacts created in the last month or to get details of deals with a certain status.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session ID obtained from a previous Login operation; used to authenticate requests. |
| Query | The actual Vtiger CRM query string to be executed. This should be a valid query command. |
Output
The node outputs JSON data representing the results returned by the Vtiger CRM API for the executed query. The structure typically includes fields and records matching the query's selection criteria.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a Vtiger CRM instance.
- Needs credentials including host URL, username, and an API access key.
- The node depends on the Vtiger CRM webservice API being accessible and properly configured.
- Uses HTTP requests to communicate with the Vtiger API endpoints.
Troubleshooting
- Invalid Session Name: If the session name is missing or expired, the query will fail. Ensure you perform a successful Login operation first to obtain a valid session ID.
- Malformed Query: Errors may occur if the query string is invalid or improperly formatted according to Vtiger's query language. Verify the syntax and correctness of your query.
- API Connectivity Issues: Network problems or incorrect host URLs can cause request failures. Confirm the Vtiger server is reachable and credentials are correct.
- Permission Denied: Insufficient permissions for the authenticated user may result in errors when running queries. Check user roles and privileges in Vtiger CRM.
Common error messages usually include descriptive text from the Vtiger API, such as authentication failures or query syntax errors. Review these messages carefully to identify the root cause.
Links and References
- Vtiger CRM Official Website
- Vtiger Webservice API Documentation
- n8n Documentation (for general node usage and credential setup)