Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. It supports various operations such as logging in, listing available types, creating, updating, describing elements, querying data, and managing sessions.
For the Describe operation specifically, the node retrieves metadata information about a specified element type within Vtiger CRM. This is useful when you want to understand the structure, fields, and properties of a particular CRM entity before performing actions like creating or updating records.
Practical examples:
- Before creating a new contact, use the Describe operation to fetch details about the "Contacts" element type to know which fields are required.
- When building dynamic forms or interfaces, use Describe to get field definitions for different CRM modules.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session ID obtained from a previous Login operation; used to authenticate requests. |
| Element Type | The type of CRM element (e.g., Contacts, Leads) to describe and retrieve metadata for. |
Output
The output JSON contains the metadata description of the specified element type from Vtiger CRM. This typically includes details such as field names, data types, mandatory status, and other attributes that define the structure of the element.
No binary data output is indicated for this operation.
Dependencies
- Requires an active Vtiger CRM instance accessible via its API endpoint.
- Needs valid credentials including host URL, username, and an API access key.
- The node uses HTTP requests to communicate with the Vtiger webservice API.
- Requires an API authentication token (session name) obtained from the Login operation to authorize requests.
Troubleshooting
- Invalid or expired session: If the session name is incorrect or expired, API calls will fail. Re-run the Login operation to obtain a fresh session ID.
- Incorrect element type: Providing an invalid or unsupported element type may result in errors or empty responses. Verify the element type by using the List Types operation first.
- Network or connectivity issues: Ensure the Vtiger CRM host URL is reachable and correct.
- API permission errors: Make sure the user credentials have sufficient permissions to perform the Describe operation.
Common error messages usually include descriptive text from the Vtiger API, such as authentication failures or invalid parameters. Review these messages to adjust inputs accordingly.
Links and References
- Vtiger CRM Official Website
- Vtiger Webservice API Documentation
- n8n Documentation on HTTP Request Node (for understanding underlying HTTP calls)