Vtiger CRM icon

Vtiger CRM

Vtiger CRM (Open Source) Node

Actions11

Overview

This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations such as creating, updating, deleting records, querying data, managing sessions, and retrieving metadata. It is useful for automating CRM workflows, synchronizing data between Vtiger and other systems, or building custom CRM-related automations.

Common scenarios include:

  • Logging in to obtain a session token.
  • Creating or updating CRM records programmatically.
  • Querying CRM data using Vtiger's query language.
  • Retrieving metadata about CRM modules or record types.
  • Managing session lifecycle by extending or logging out sessions.

For example, a user might automate lead creation by sending new lead data from a form submission directly into Vtiger using the "Create" operation.

Properties

Name Meaning
Session Name The session token obtained through the Login operation; required for most operations except login itself.

Note: The provided input properties only include "Session Name" because the request was scoped to the Default Resource and Operation, which corresponds to the general session management property used across many operations.

Output

The node outputs a JSON array containing the response from the Vtiger CRM API corresponding to the requested operation. The structure of the JSON depends on the operation performed:

  • For login, it returns authentication details including the session name/token.
  • For create, update, delete, and sync, it returns the result status and any relevant identifiers.
  • For query and retrieve, it returns the requested CRM data records.
  • For describe and listtypes, it returns metadata about CRM modules or record types.
  • For extend_session and logout, it returns confirmation of the session action.

No binary data output is produced by this node.

Dependencies

  • Requires an active Vtiger CRM instance accessible via HTTP(S).
  • Needs credentials including the host URL, username, and an access key (API key) for authentication.
  • Uses the crypto-js library internally to generate MD5 hashes during the login process.
  • Requires proper configuration of the API credentials within n8n to authenticate requests.

Troubleshooting

  • Invalid Credentials or Access Key: If login fails, ensure the username and access key are correct and that the Vtiger instance is reachable.
  • Session Expired: Operations requiring a session name will fail if the session has expired; use the "Extend Session" or "Login" operation to renew.
  • Operation Not Implemented Error: This error occurs if an unsupported operation value is set; verify the operation parameter is one of the supported options.
  • Network Issues: Ensure the Vtiger host URL is correct and accessible from the n8n environment.
  • Malformed Input Data: For create/update operations, ensure the JSON element data matches Vtiger's expected format.

Links and References

Discussion