Vtiger CRMInstall

Overview

The node integrates with Vtiger CRM, an open-source customer relationship management system. It allows users to perform various operations such as creating records, describing metadata of record types, querying data, retrieving specific records, and deleting records within a Vtiger CRM instance.

For the Describe operation specifically, the node fetches metadata information about a specified element type (record type) in Vtiger CRM. This is useful for understanding the structure, fields, and properties of different CRM modules or entities before performing further actions like creating or updating records.

Practical examples:

• Before creating a new "Contacts" record, use the Describe operation to get details about required fields and field types.
• Retrieve metadata for custom modules to dynamically build forms or validate input data in workflows.

Properties

Output

The output is a JSON object containing the metadata description of the specified element type. This typically includes details such as:

• Field names
• Data types
• Field labels
• Whether fields are mandatory or optional
• Other attributes related to the CRM module's structure

This metadata helps users understand how to interact with that element type programmatically.

The node does not output binary data.

Dependencies

• Requires connection credentials to a Vtiger CRM instance, including host URL, username, and an API access key.
• Uses HTTP requests to communicate with the Vtiger CRM webservice API.
• Requires an active session name obtained via the Login operation to authenticate API calls.

Troubleshooting

• Common issues:

  • Invalid or expired session name: Ensure you have performed a successful login operation and are using the current session token.
  • Incorrect element type: Verify the element type string matches a valid module/entity in your Vtiger CRM instance.
  • Network or authentication errors: Check connectivity to the Vtiger server and validity of credentials.

• Error messages:

  • If the session is invalid or expired, the API may return an error indicating authentication failure. Re-run the login operation to obtain a fresh session.
  • If the element type is unknown, the API response will indicate that the requested module does not exist.
  • Unimplemented operation errors will be thrown if attempting unsupported operations like "extend_session" or "logout".

Links and References

• Vtiger CRM Official Website
• Vtiger CRM Webservice API Documentation
• n8n Documentation on Creating Custom Nodes