Skip to main content

​
Extra information

Connector package documentation: System documentation: Zoho CRM API Reference

​
Setting up HTTP Client Zoho CRM

Steps
  1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Zoho CRM HTTP Client as the prototype of the HTTP Client.
  2. Fill in the Base URI field according to your Zoho CRM account.
  3. Check for the Access Token URL and Authorize URL if they are in the right region for your Zoho CRM Account.
  4. Fill in the Client ID and Client Secret field based on your credentials.
  5. Fill in the Scopes field.
  6. You can optionally enable logging of requests.
  7. Then, click on “Grant Access to Zoho CRM” and approve the request on page opening.
  8. The Key will show up and you can save the Client for use.

​
Subscribing to Entities from Zoho CRM

Steps
  1. Go to Connections -> Incoming and create a new incoming configuration and select Zoho CRM Subscriber as the subscriber.
  2. Select the entity you want to subscribe to from Zoho CRM.
  3. The request parameters must have at least two parameters. Path and Query. The Path is used when you need to put parameters into a URL such as ID. And the Query is used when you need to add a request query when submitting a request, like filtering.
  4. You can optionally add a transformer to transform the request parameters into something you need.
  5. Select the Zoho CRM HTTP Client to use
General Concept We follow Zoho CRM documentation on building this connector so you can easily use the connector based on Zoho CRM API Reference. Entity It’s the entity you want to subscribe from Zoho CRM. Please refer to the entities in Management APIs from Zoho CRM API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on Zoho CRM API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get a User by Identity. We can see in the documentation that setting by Id entity requires user_id as a path parameter to define which order we want to fetch the details from. Zoho CRM connector screenshot 1 In order to fill the user_id with the actual User ID you want to get the details from, we need to define the user_id property inside the path property in the Request Parameters field. And also, as you can see the endpoints requires API version in a call, so you need to define the version. 
{
    "path": {
        "user_id": "12345",
        "version": "v3"
    },
    "query": {},
    "payload": []
}
Input Transformer Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. HTTP Client It’s the HTTP Client configuration or prototype you will use to access Zoho CRM.

​
Publishing Entity to Zoho CRM

Steps
  1. Go to Connections -> Outgoing, create a new outgoing configuration and select Zoho CRM Publisher as the publisher.
  2. Select the action that you want the publisher to do with the data. Alumio support Create (HTTP POST METHOD), Put, Patch and Delete
  3. Select the Zoho CRM entity you want the data to be published to.
  4. Please note that the data format before sending must in this format: 
{
    "path": {},
    "query": {},
    "payload": {
        //Your data Here
    }
}
PATH is used when you need to add a parameter to the URL where you want to send the data. PAYLOAD contains all of the data which do you want to send.
  • Select the HTTP Client to use.
General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). Action Currently, we support action Create (HTTP POST METHOD), Put (HTTP PUT METHOD), Patch (HTTP PATCH METHOD), and Delete (HTTP DELETE METHOD) data to Zoho CRM. Entity We support publishing to most Zoho CRM endpoints. Please refer to Zoho CRM API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For example, we want to update the user’s data. Zoho CRM connector screenshot 2 The documentation says that we need user id and api version as path parameters. In that case, you need to provide user_id property into the path property in the data, either as an output from Routes or output from Transformers in Outgoing Configuration. And you can put the payload you want to send to Zoho CRM into the payload property in the data. Here is an example of the required data. 
{
    "path": {
        "user_id": "example01",
        "version": "v3"
    },
    "query": {},
    "payload": {
        //your data here
    }
}
HTTP Client It’s the HTTP Client configuration or prototype you will use to access Zoho CRM.