Vtiger CRM

Overview

This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations on CRM data via its webservice API. The "Retrieve" operation specifically fetches a record from Vtiger CRM by its unique Webservice ID within an active session.

Common scenarios for using the "Retrieve" operation include:

• Fetching detailed information about a specific CRM record (e.g., a contact, lead, or account) when you have its identifier.
• Integrating Vtiger CRM data into workflows that require up-to-date record details.
• Automating data synchronization or reporting tasks where individual record data is needed.

Practical example:

• After creating a new lead in Vtiger CRM, use the "Retrieve" operation to get the full details of that lead for further processing or notification.

Properties

Output

The node outputs a JSON array containing the response from the Vtiger CRM webservice API for the "Retrieve" operation. The JSON structure typically includes:

• success: Boolean indicating if the retrieval was successful.
• result: An object containing the detailed fields and values of the requested CRM record.
• error: If unsuccessful, an error object with message and code.

No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "success": true,
    "result": {
      "id": "12x345",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john.doe@example.com",
      ...
    }
  }
]

Dependencies

• Requires connection credentials to the Vtiger CRM instance, including:
  • Host URL of the Vtiger CRM server.
  • Username and access key for authentication.
• The node uses HTTP requests to communicate with the Vtiger webservice API endpoint /webservice.php.
• The session token ("Session Name") must be valid and obtained through the "Login" operation before performing "Retrieve".

Troubleshooting

• Invalid Session: If the session token is expired or invalid, the API will return an error. Re-authenticate using the "Login" operation to obtain a fresh session token.
• Record Not Found: Providing an incorrect or non-existent Webservice ID will result in an error or empty result. Verify the ID is correct.
• Network Issues: Connection failures to the Vtiger host will cause errors. Ensure the host URL is reachable and correct.
• Missing Credentials: The node requires proper API credentials; missing or incorrect credentials will prevent successful requests.
• Operation Not Implemented Errors: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.

Links and References

• Vtiger CRM Official Documentation
• Vtiger Webservice API Reference
• n8n Documentation on Creating Custom Nodes