Overview
This node integrates with Vtiger CRM (an open-source customer relationship management system) to perform various operations on CRM data via its webservice API. The "Retrieve" operation specifically fetches a single entity record from Vtiger CRM using its unique Entity ID.
Common scenarios for this node include:
- Fetching detailed information about a specific CRM record (e.g., a Lead, Contact, or Account) by its ID.
- Integrating Vtiger CRM data retrieval into automated workflows, such as syncing CRM data with other systems or triggering actions based on CRM record details.
Practical example:
- Retrieve the details of a Lead with the Entity ID "1x1234" to use in a follow-up email campaign or update another database.
Properties
| Name | Meaning |
|---|---|
| Entity ID | The unique identifier of the CRM entity to retrieve, formatted as MODULExID (e.g., "1x1234"). This is required for the "retrieve", "delete", and "update" operations. |
Output
The output is a JSON array containing the response from the Vtiger CRM API for the requested entity. The structure typically includes:
success: Boolean indicating if the request was successful.result: An object representing the retrieved entity's data fields and their values.error(if any): Details about errors encountered during the request.
Example output snippet:
[
{
"success": true,
"result": {
"id": "1x1234",
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@example.com",
...
}
}
]
No binary data output is produced by this node.
Dependencies
- Requires an active connection to a Vtiger CRM instance with valid credentials including:
- Host URL of the Vtiger CRM server.
- Username.
- Access key (used to generate an access token).
- The node uses the Vtiger webservice API endpoints (
/webservice.php) for all operations. - Proper API credentials must be configured in n8n prior to using this node.
Troubleshooting
- Authentication errors: If the node fails at the challenge or login step, verify that the username and access key are correct and that the Vtiger host URL is reachable.
- Entity not found: When retrieving an entity, if the ID does not exist or is malformed, the node will throw an error indicating the entity does not exist.
- Invalid Entity ID format: Ensure the Entity ID follows the "MODULExID" format (e.g., "1x1234") as expected by Vtiger.
- Network issues: Timeouts or connectivity problems to the Vtiger server will cause failures; check network settings and server availability.
- Unsupported operation: Using an operation not implemented by the node will result in an explicit error message.