Actions12
Overview
The node integrates with Vtiger CRM (an open-source CRM platform) to perform various operations via its webservice API. Specifically, the Query Related operation allows users to query related records linked to a specific record in Vtiger CRM. This is useful when you want to retrieve data that is associated or connected to a particular entity, such as fetching all contacts related to an account or all activities related to a deal.
Common scenarios include:
- Retrieving related records for detailed reporting or processing.
- Automating workflows that depend on relationships between CRM entities.
- Extracting linked data without multiple separate queries.
Example: Query all "Contacts" related to a specific "Account" by providing the Account's Webservice ID and specifying the related label "Contacts".
Properties
| Name | Meaning |
|---|---|
| Session Name | The session token obtained from a successful login operation; required for authentication. |
| Webservice ID | The unique identifier of the main record in Vtiger CRM for which related records are queried. |
| Query | The Vtiger query string to filter or specify the data to retrieve from related records. |
| Related Label | The label/name of the related module/entity to fetch records from (e.g., "Contacts", "Potentials"). |
Output
The node outputs a JSON array containing the response from the Vtiger CRM API for the query_related operation. The structure typically includes:
- A success flag indicating if the request was successful.
- A result field containing the list of related records matching the query.
- Metadata or error information if applicable.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a Vtiger CRM instance via its webservice API.
- Needs valid credentials including host URL, username, and an API access key.
- The node uses HTTP requests to communicate with the Vtiger API endpoints.
- The session token must be managed externally, typically obtained through the Login operation of this node.
Troubleshooting
- Invalid Session Name: If the session token is expired or invalid, the API will reject requests. Ensure you perform a fresh login to obtain a valid session token.
- Incorrect Webservice ID: Providing an incorrect or non-existent record ID will result in empty or error responses.
- Malformed Query: The query string must follow Vtiger's query syntax; otherwise, the API may return errors.
- Related Label Errors: Using an incorrect related label that does not exist for the given record type will cause failures.
- Network Issues: Connectivity problems to the Vtiger host will prevent API calls from succeeding.
Error messages returned by the API are passed through and should be reviewed to adjust parameters accordingly.