Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. It allows users to perform various operations such as logging in, listing available types, and synchronizing data with the CRM.
The Sync operation (the focus here) is intended to synchronize records between n8n and Vtiger CRM, ensuring that data changes are reflected accurately on both sides. This can be useful for keeping contact lists, sales opportunities, or other CRM entities up-to-date automatically.
Practical examples include:
- Automatically syncing updated customer information from Vtiger into another system.
- Keeping a local database aligned with changes made in Vtiger CRM.
- Triggering workflows based on synchronized data changes.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session ID obtained from a prior login operation. Required to authenticate and authorize API requests for synchronization. |
Output
The node outputs JSON data representing the response from the Vtiger CRM API for the Sync operation. This typically includes details about the synchronized records, such as their IDs, statuses, or any errors encountered during sync.
No binary data output is indicated in the source code.
Dependencies
- Requires an active connection to a Vtiger CRM instance.
- Needs credentials including host URL, username, and an access key (API key).
- Uses HTTP requests to communicate with the Vtiger webservice API endpoints.
- Relies on the
crypto-jslibrary for generating MD5 hashes during login authentication.
Troubleshooting
- Invalid or expired session: If the session name is incorrect or expired, API calls will fail. Ensure you perform a successful login operation first to obtain a valid session ID.
- Login failures: Errors during login often relate to incorrect credentials or network issues. Check the username, access key, and host URL.
- Unsupported operation error: If the Sync operation is not implemented fully in the node's code, it may throw an error indicating this. Currently, only "login" and "list_type" operations have implemented logic; others, including "sync," will raise an error.
- Network or API errors: These can occur if the Vtiger server is unreachable or returns an error. Review error messages returned by the API for guidance.
Links and References
- Vtiger CRM Official Website
- Vtiger Webservice API Documentation
- crypto-js GitHub Repository (for understanding MD5 hashing used in login)
Note: The provided source code does not implement the Sync operation logic explicitly; it throws an error if Sync is selected. Therefore, the above description assumes typical use cases of a Sync operation in a Vtiger CRM integration context.