Overview
The node integrates with Vtiger CRM, an open-source customer relationship management system. Specifically, the Sync operation synchronizes data between the node and the Vtiger CRM instance. This operation is useful for keeping local or external systems up to date with changes in the CRM without manually querying or updating records.
Typical use cases include:
- Automatically syncing updated CRM data into other business tools or databases.
- Triggering workflows based on the latest CRM data state.
- Ensuring data consistency across multiple platforms by periodically syncing.
For example, a user might schedule this node to run regularly to fetch all recent changes from Vtiger CRM and update their internal reporting system accordingly.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session identifier string obtained through a prior login operation; required to authenticate and authorize the sync request. |
Output
The output of the Sync operation is a JSON object representing the response from the Vtiger CRM API's sync endpoint. This typically includes details about the synchronized data such as updated records, deleted records, or any metadata related to the synchronization process.
The node does not output binary data.
Dependencies
- Requires an active connection to a Vtiger CRM instance via its webservice API.
- Needs valid credentials including:
- The host URL of the Vtiger CRM server.
- A username and access key for authentication.
- The node uses an API key credential (access key) to perform authenticated requests.
- The
Session Nameparameter must be provided, which is usually obtained from a successful Login operation within the same workflow or previously.
Troubleshooting
- Invalid or expired session name: If the session name is missing, invalid, or expired, the sync operation will fail. Ensure you have performed a successful login operation beforehand and are passing the correct session name.
- Authentication errors: Incorrect credentials or access keys will cause authentication failures. Verify that the API key and username are correct.
- Network or connectivity issues: The node requires network access to the Vtiger CRM server. Check firewall settings and server availability.
- API errors: The node throws errors if the Vtiger API returns an error message. Review the error message for clues, such as permission issues or malformed requests.
- Operation not implemented: If an unsupported operation is specified, the node will throw an error indicating the operation is not implemented.