Overview
The node integrates with Vtiger CRM (an open-source customer relationship management system) via its webservice API. It supports multiple operations to manage CRM data, including creating, retrieving, updating, deleting records, querying data, managing sessions, and more.
Specifically, the Retrieve operation fetches a record from Vtiger CRM by its unique Webservice ID within an active session. This is useful when you want to get detailed information about a specific CRM entity, such as a contact, lead, or account, identified by its ID.
Common scenarios:
- Fetching details of a customer or lead for further processing.
- Retrieving a record before updating it.
- Accessing CRM data to use in workflows or reports.
Example:
You have a workflow that triggers on a new email and wants to enrich the data by retrieving the corresponding contact's full details from Vtiger CRM using their Webservice ID.
Properties
| Name | Meaning |
|---|---|
| Session Name | The active session token obtained through a prior login operation; required for authentication in all operations except login. |
| Webservice ID | The unique identifier of the CRM record to retrieve or delete. Required for Retrieve and Delete operations. |
Output
The output is a JSON array containing the response from the Vtiger CRM webservice API for the Retrieve operation. The structure typically includes:
success: Boolean indicating if the request was successful.result: An object representing the retrieved CRM record with all its fields and values.error: If unsuccessful, contains error details.
No binary data is returned by this operation.
Example output snippet:
[
{
"success": true,
"result": {
"id": "12x345",
"firstname": "John",
"lastname": "Doe",
"email": "[email protected]",
...
}
}
]
Dependencies
- Requires an active Vtiger CRM instance accessible via HTTP(S).
- Needs credentials including host URL, username, and access key for authentication.
- The node uses the Vtiger webservice API endpoint
/webservice.php. - Requires a valid session token (
Session Name) obtained from the Login operation before performing Retrieve.
Troubleshooting
- Invalid Session Name: If the session token is expired or invalid, the API will return an error. Re-authenticate using the Login operation to obtain a fresh session token.
- Incorrect Webservice ID: Providing a wrong or non-existent ID will result in an error or empty result. Verify the ID before retrieval.
- Network Issues: Ensure the Vtiger CRM host URL is reachable from n8n.
- API Errors: The node throws errors with messages from the Vtiger API. Check the error message and code for specifics.
- Missing Credentials: The node requires proper API credentials configured in n8n; missing or incorrect credentials will cause failures.