Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. It allows users to perform various operations such as creating, describing, updating, deleting records, querying data, managing sessions, and more within a Vtiger CRM instance.
The Describe operation specifically retrieves metadata information about a particular element type (e.g., Contacts, Accounts) in the CRM. This is useful for understanding the structure, fields, and properties of that element type before performing further actions like creating or updating records.
Practical examples:
- Before creating a new Contact record, use the Describe operation to fetch all available fields and their types.
- Use Describe to dynamically build forms or interfaces based on the CRM's current schema.
- Validate input data against the described element structure.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session identifier string obtained from a successful login operation. Required to authenticate subsequent requests. |
| Element Type | The type of CRM element to describe (e.g., Contacts, Accounts). Specifies which entity's metadata to retrieve. |
Output
The output is a JSON object containing the response from the Vtiger CRM API for the describe operation. This typically includes detailed metadata about the specified element type, such as:
- Field names
- Data types
- Field labels
- Possible picklist values
- Other attributes defining the structure of the element
This metadata helps users understand how to interact with that element type programmatically.
No binary data output is produced by this operation.
Dependencies
- Requires an active Vtiger CRM instance accessible via HTTP(S).
- Needs an API authentication token (session name) obtained through the Login operation.
- Requires credentials configured in n8n for connecting to the Vtiger CRM API, including host URL, username, and access key.
- Uses the
crypto-jslibrary internally for hashing during login but not directly relevant for Describe operation.
Troubleshooting
- Invalid Session Name: If the session name is expired or invalid, the API will reject the request. Re-authenticate using the Login operation to obtain a fresh session.
- Incorrect Element Type: Providing an invalid or misspelled element type may result in errors or empty responses. Verify the element type exists in your Vtiger CRM.
- Network Issues: Ensure the Vtiger CRM host URL is correct and reachable from the n8n environment.
- API Errors: The node throws errors with messages returned from the Vtiger API. Check the error message and code for details.