Vtiger CRM icon

Vtiger CRM

Vtiger CRM (Open Source) Node

Actions12

Login

AI-generated

Overview

This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations such as logging in, creating, updating, deleting records, querying data, and describing metadata. The Login operation specifically handles authenticating a user by obtaining a session token from the Vtiger CRM API using the provided credentials.

Typical use cases include:

  • Automating CRM workflows by programmatically logging into Vtiger and performing subsequent operations.
  • Integrating Vtiger CRM data with other systems by first establishing a valid session.
  • Retrieving session tokens for use in other node operations that require authentication.

For example, a user might use the Login operation to authenticate and obtain a session name, which can then be used in later operations like creating or querying CRM records.

Properties

Name Meaning
Session Name A string representing the session token obtained through a successful Login operation. Required for most operations except Login itself.

Note: For the Login operation, the "Session Name" property is hidden because it is not needed as input; instead, it is generated by this operation.

Output

The output of the Login operation is a JSON object containing the response from the Vtiger CRM API login endpoint. This typically includes:

  • success: Boolean indicating if the login was successful.
  • result: An object containing session details such as the sessionName token.
  • Other metadata returned by the API.

This session token (sessionName) is essential for authenticating subsequent requests to the Vtiger API.

The node does not output binary data.

Dependencies

  • Requires an API credential with access to the Vtiger CRM instance, including:
    • Host URL of the Vtiger CRM server.
    • Username.
    • Access key (used to generate an MD5 hash for authentication).
  • Uses the crypto-js library internally to compute MD5 hashes for secure login.
  • The node makes HTTP requests to the Vtiger CRM webservice endpoints.

Troubleshooting

  • Common issues:

    • Incorrect credentials (username or access key) will cause login failure.
    • Network connectivity problems to the Vtiger host will prevent API calls.
    • Using an invalid or expired session token in subsequent operations will result in authorization errors.

  • Error messages:

    • If the initial challenge request fails, the node throws an error with the message and code returned by the Vtiger API.
    • Operations marked as "not implemented" will throw explicit errors if attempted (e.g., "extend_session", "logout", "sync").

  • Resolution tips:

    • Verify the correctness of the username and access key.
    • Ensure the Vtiger CRM server URL is reachable from the n8n environment.
    • Use the Login operation first to obtain a valid session token before other operations.

Links and References

Discussion