Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. The "Login" operation allows users to authenticate against the Vtiger CRM API by obtaining a session token. This is useful for workflows that need to perform subsequent authenticated actions within Vtiger, such as querying or updating records.
A common scenario is automating data synchronization between Vtiger CRM and other systems, where the node first logs in to establish a session before performing further operations. For example, a user might trigger this node to log in and retrieve a session token, which can then be used in later nodes to query contacts or update deals.
Properties
| Name | Meaning |
|---|---|
| Session Name | (Not applicable for Login operation) |
Note: The "Session Name" property is hidden when the operation is "login" and thus not used in this context.
Output
The output of the "Login" operation is a JSON object containing the response from the Vtiger CRM login API. It includes details such as:
success: Boolean indicating if login was successful.result: Contains session information including the session name/token.- Other metadata returned by the API.
This JSON output can be used downstream in the workflow to reference the authenticated session for further API calls.
Dependencies
- Requires an API credential with:
- Host URL of the Vtiger CRM instance.
- Username.
- Access key (used to generate an MD5 hash for authentication).
- Uses the
crypto-jslibrary internally to compute the MD5 hash needed for login. - Requires network access to the Vtiger CRM webservice endpoint (
/webservice.php).
Troubleshooting
- Common issue: Login failure due to incorrect credentials or host URL.
- Error message will include the API error message and code.
- Verify the username, access key, and host URL are correct.
- Error: If the initial challenge request fails (
getchallenge), the node throws an error with the message from the API. - Resolution: Ensure the Vtiger CRM instance is reachable and credentials are valid. Check network connectivity and firewall settings.
Links and References
- Vtiger CRM API Documentation
- crypto-js on npm (for MD5 hashing)