Overview
This node integrates with Vtiger CRM, an open-source customer relationship management system. It allows users to perform various operations such as logging in, listing available types, creating, updating, describing, retrieving, deleting records, querying data, syncing, extending sessions, and logging out.
For the Create operation specifically (under the "Default" resource), the node enables users to create new records of a specified element type in Vtiger CRM by providing the record details as JSON. This is useful for automating the addition of new contacts, leads, or other entities into the CRM directly from workflows.
Practical examples:
- Automatically adding new leads captured from a web form into Vtiger CRM.
- Creating support tickets in Vtiger when certain conditions are met in another system.
- Populating custom modules with data from external sources.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session ID obtained from a previous login operation; required to authenticate requests. |
| Element | The JSON object representing the record data to be created in Vtiger CRM. |
| Element Type | The type of entity (module) to create, e.g., Contacts, Leads, Accounts, etc. |
Output
The node outputs an array of JSON objects representing the response from the Vtiger CRM API after attempting to create the record. This typically includes information about the newly created record such as its unique ID and any status messages returned by the API.
No binary data output is indicated.
Dependencies
- Requires an active Vtiger CRM instance accessible via HTTP(S).
- Needs credentials including host URL, username, and an API access key for authentication.
- Uses the
crypto-jslibrary internally for hashing during login. - Requires proper session management: a valid session name (session ID) must be provided for operations other than login.
Troubleshooting
- Invalid or expired session: If the session name is incorrect or expired, API calls will fail. Ensure you perform a login operation first to obtain a valid session ID.
- Incorrect element JSON: Malformed or incomplete JSON in the "Element" property can cause API errors. Validate JSON structure before execution.
- Missing or incorrect element type: The "Element Type" must correspond to a valid module/entity in Vtiger CRM. Using an invalid type will result in errors.
- API connection issues: Verify that the host URL and credentials are correct and that the Vtiger CRM server is reachable.
- Error messages from API: The node throws errors with messages returned by the Vtiger API, often including error codes. Review these messages to diagnose issues like permission problems or invalid parameters.