My Experience with Zoho CRM API Integration [Developer Review]

June 9, 2018 3 min read

Hello folks,

I am sharing my experience with Zoho CRM, I have integrated one project with Zoho CRM API, and it was my nice experience with Zoho CRM API integration using Zoho CRM webhook.

webhook is very useful for real-time Synchronization of data, it avoids unnecessary calls and polling.

First of all, I Introduce the Wrapper package which I used for Zoho CRM API integration for performing Insertion, Updation, Deletion vice versa.

I downloaded the Zoho CRM Wrapper Package from GitHub by using this wrapper a .net client can interact with the Zoho CRM Service.

Below are Details of the Wrapper Package of Zohocrmsharp

Wrapper Name: zohocrmsharp

Download URL: https://github.com/deveel/zohocrmsharp

Let’s talk now

Do You Need Help in ZOHO CRM API Integration?

Hire Zoho CRM Integration Developer and web services experts remotely.

Screenshot of a GitHub repository page for "zohocrmsharp" in the "deveel" repository. The page includes a description, branch information, and options to find files or clone/download the repository. This project focuses on Zoho CRM API integration.

In zohocrmsharp wrapper ZohoCrmClient class file is used for Insert, Update, and Delete Lead, Account, Contact, Sales Order, Purchase Order, etc. Below is a screenshot of the Wrapper Method of the ZohocrmClient Class used for performing the operation.

Insert Record:

A screenshot of a programming interface showing a section of Zoho CRM client code in C# with a function for inserting records into a collection. The code highlights seamless Zoho CRM API integration, featuring several insert assertions and collection operations.

Delete Record:

Screenshot of a C# code snippet that checks for a null record and throws an exception if the ID is null or empty, then deletes a record by ID. It also shows a method for deleting records by ID and module name, useful for Zoho CRM API integration.

Update Record:

A screenshot of a code editor shows C# code for managing records in a Zoho CRM client, integrating the Zoho CRM API with specific methods handling entity records and throwing exceptions for unidentified records.

Now How to listen to a webhook request coming from Zoho CRM?

For Receive Zoho CRM Webhook Response I have Created asp.net MVC API Project and created GET Method for Receive Response from CRM Webhook in parameter use FormDataCollection

Below is a screenshot of the POST API call

Screenshot of a code editor displaying C# code for a function handling webhooks, crucial for Zoho CRM API integration. Comments in yellow highlight the function and explain the handling of null form data.

Deploy This MVC API Project strictly on standard port 80 or 443. The non-standard port doesn’t work. So you will receive a response of webhook to your MVC API Project and perform Integration between our application and Zoho CRM.

How to set up webhook with workflow?

Setup Webhook :

For the Creation of a Webhook Login into Zoho CRM Click on the settings icon and search for webhook.

A software setup screen with a submenu labeled 'Webhooks' highlighted. Options include Rules, Workflow Rules, and Webhooks Actions, enabling seamless Zoho CRM API integration. Various other setup categories are listed below.

Then you can create a webhook by clicking on Configure webhook.

You need to provide the below details for webhook creation:

Name of webhook: give the meaning of the full name of the webhook like “Create Lead”

URL to Notify: you need to provide the URL of where you deploy the ZOHO CRM API Project on the standard port.

Method: Select a method like POST or GET. (in our case POST)

Description: provide a description of the webhook, for example, create a webhook for lead creation. Then select a module from the dropdown like Lead, Account, Contact, etc..! and save to create.

Module: Select Module for webhook, it’s important to select a module to forget the response of which module. For example Leads, Accounts, Contacts, Orders, etc.

Parameters: if anyone wants only a particular record as a parameter then it can be defined in the Append Entity Parameter.

Append Custom Parameter: if anyone wants to provide security for accessing webhooks then they can append a custom parameter for that like Auth token and API Key. which can ensure our MVC API endpoint that Given Request is coming from the valid source.

Screenshot of a "New Webhook" setup page in Zoho CRM API integration, showing fields for Name, URL to Notify, Method, Description, and Module. Toggle options for POST and GET methods are visible, along with various other configuration settings.

Setup Webhook WorkFlow :

What is webhook workflow and why needed?

Webhook workflow is provided by Zoho CRM for executing an action based on rules.
When we need to act like insertion, deletion, or update based on condition then we need to set up workflow for execution based on configuration.

How to Set Rules:

Log in to Zoho CRM and click on the setting icon in the right-hand side corner.
In Automation, you can find Workflow rules.
Then after you need to click on Create Rule button.
Then Select Module from the drop-down, which you want to create a rule for that.
Give the Rule Name, and describe the Rule.
After Clicking on the next Zoho CRM provides a User interface for creating a rule as per the below screenshots: First, Create a When Condition When to execute the rule. Example: Create, Edit, Create/Edit, Delete.
Then after the application condition for record matching, for example, if a Lead source is selected is “Advertisement” then and then webhook trigger should be fire. So when a lead is created or updated with the Source “Advertisement” then Webhook response is getting otherwise not.
After Set Condition clicks on next for selecting an action to perform on webhook, you need to select an instant action for executing this rule, so select webhook from instant Action.
After Selecting webhook you need to Associate your created webhook.
After Associate Webhook with the Workflow rule, you need to save the workflow rule.
In the same way, you can set many workflow rules for different modules as per the requirement.

After setup everything now creates a lead with source “Advertisement” gets a webhook response and integrates with your application..!!!