Vtiger CRM icon

Vtiger CRM

Vtiger CRM (Open Source) Node

Overview

This node integrates with the Vtiger CRM (Open Source) system, allowing users to perform various operations such as creating, deleting, retrieving, querying, and updating records within Vtiger. Specifically, the Delete operation removes a record from Vtiger based on its unique Webservice ID.

Common scenarios for using the Delete operation include:

  • Removing outdated or incorrect CRM records automatically as part of a workflow.
  • Cleaning up test data after automated testing.
  • Managing data lifecycle by deleting records that meet certain criteria.

For example, after identifying a contact record that is no longer valid, this node can be used to delete it from Vtiger by providing the session authentication and the record's Webservice ID.

Properties

Name Meaning
Session Name The active session identifier obtained through a prior Login operation; required for authentication in all operations except login.
Webservice ID The unique identifier of the Vtiger record to delete.

Output

The output is a JSON object representing the response from the Vtiger API after attempting the delete operation. This typically includes success status and any relevant messages or error details returned by the API.

Example structure:

{
  "success": true,
  "result": {
    // Details about the deleted record or confirmation message
  }
}

No binary data output is produced by this node.

Dependencies

  • Requires an active Vtiger CRM instance accessible via HTTP(S).
  • Needs an API authentication token (session name) obtained through the Login operation.
  • Requires configuration of credentials containing the Vtiger host URL, username, and access key.
  • Uses standard HTTP requests with application/x-www-form-urlencoded content type.

Troubleshooting

  • Invalid Session Name: If the session name is expired or invalid, the API will reject the request. Ensure you have performed a successful Login operation and are using the current session name.
  • Incorrect Webservice ID: Providing a wrong or non-existent Webservice ID will result in an error or no action. Verify the ID corresponds to an existing record.
  • Network Issues: Connectivity problems to the Vtiger host will cause request failures. Check network access and host availability.
  • API Errors: The node throws errors if the underlying API returns failure responses. Review the error message for details and verify parameters.
  • Unimplemented Operations: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.

Links and References

Discussion