Overview
This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations such as login, list types, retrieve records, create, update, delete, and more. Specifically, the Retrieve operation fetches a record from Vtiger CRM by its unique Webservice ID using an active session.
Common scenarios for this node include:
- Automating data retrieval from Vtiger CRM for use in workflows.
- Synchronizing CRM data with other systems.
- Fetching detailed information about specific CRM records based on their IDs.
For example, after logging in and obtaining a session token, you can use the Retrieve operation to get details of a contact or lead by specifying its Webservice ID.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session ID obtained from a previous Login operation; required to authenticate requests. |
| Webservice ID | The unique identifier of the CRM record to retrieve. |
Output
The output is a JSON array containing the response from the Vtiger CRM API for the requested record. This typically includes all fields and values associated with the specified Webservice ID in the CRM.
If the node supported binary data output, it would be summarized here, but this node outputs only JSON data representing CRM records.
Dependencies
- Requires an active Vtiger CRM instance accessible via HTTP(S).
- Needs credentials including host URL, username, and an API access key for authentication.
- Uses the
crypto-jslibrary internally for hashing during login. - Requires proper configuration of the API credentials within n8n to connect securely.
Troubleshooting
- Invalid Session: If the session name is incorrect or expired, the node will fail to retrieve data. Ensure that the session token is valid and refreshed if necessary.
- Incorrect Webservice ID: Providing an invalid or non-existent Webservice ID will result in errors or empty responses. Verify the ID before use.
- API Connection Issues: Network problems or incorrect host URLs can cause request failures. Confirm connectivity and correct endpoint configuration.
- Authentication Errors: Login failures due to wrong credentials or access keys will prevent any operation except login. Double-check credential correctness.
Common error messages include:
"Invalid Session"or"Session Expired": Re-login to obtain a new session token."Record Not Found": Check the Webservice ID for typos or existence.- HTTP errors like 401 or 403 indicate authentication or permission issues.
Links and References
- Vtiger CRM Official Documentation
- Vtiger Webservice API Guide
- CryptoJS Library used internally for hashing during login