Overview
This node integrates with the Vtiger CRM API, enabling users to perform various operations on Vtiger entities. The "Retrieve" operation specifically fetches detailed information about a single entity in Vtiger by its unique ID. This is useful when you want to get up-to-date data for a specific record, such as a contact, lead, or account, within an automated workflow.
Practical examples include:
- Automatically retrieving customer details when processing support tickets.
- Fetching product or deal information before updating related records.
- Integrating Vtiger data into other systems by pulling entity details dynamically.
Properties
| Name | Meaning |
|---|---|
| Entity ID | The unique identifier of the entity to retrieve, formatted as MODULExID (e.g., "1x1234"). |
Output
The output is a JSON array containing the response from the Vtiger API's "retrieve" operation. It includes all fields and values associated with the specified entity ID, reflecting the current state of that record in Vtiger.
If the node supports binary data output (not applicable for "Retrieve"), it would represent files or attachments; however, this operation only returns JSON data.
Dependencies
- Requires connection credentials to a Vtiger CRM instance, including host URL, username, and an API access key.
- The node performs authentication via a challenge-response mechanism using these credentials.
- No additional external dependencies beyond standard HTTP requests and form-data handling.
Troubleshooting
- Authentication errors: If the node fails at the login step, verify that the provided credentials (username and API key) are correct and have sufficient permissions.
- Invalid Entity ID: Errors may occur if the Entity ID is malformed or does not exist. Ensure the ID follows the MODULExID format and corresponds to an existing record.
- API endpoint issues: Network connectivity or incorrect host URL can cause request failures. Confirm the Vtiger host URL is reachable and correct.
- Unexpected API errors: The node throws errors with messages returned by the Vtiger API. Review these messages for clues, such as permission issues or invalid parameters.