How to Create a Zoho Custom Connection

Hugh Marshall

In this article we will show you how you can create your own custom connections.

Why create a custom connection?

A custom connection is necessary following the Zoho OAuth deprecation primarily because the deprecated connector was unique in its ability to handle multi-application connections by listing scopes across various Zoho apps simultaneously. You will also find the default connectors are missing scopes required for certain API calls.

Configuration Guide

Here are the steps to take to create your own custom connector with Zoho.

Generate Your API Credentials

First you must register your "client" to get the necessary security keys.
  • Go to the Zoho API Console (api-console.zoho.com)
  • Click "Add Client" and select "Server-based application"
  • Enter a name (do not use "Zoho" in the name), your homepage URL, and your Authorized Redirect URI. This URI is specific to your domain region and can be located at this link: https://www.zoho.com/deluge/help/connections.html
  • Once created, Zoho will provide a Client ID and Client Secret. Copy these back into your Custom Service settings in your Zoho app below.

Create a Custom Connection Service

Navigate to the connectors section in your Zoho application (such as Zoho CRM) and locate Custom Services. Click "Create Service" and fill in the following basic details:
  • Service Name: Give your connector a recognisable name such as Zoho CRM
  • Authentication Type: Select OAuth2
  • Parameter: Choose Header
  • Grant Type: Select Authorization Code.
  • Client ID/Consumer Key: Obtained from API Console
  • Client Secret/Consumer Secret: Obtained from API Console
  • Authorize URL: https://accounts.zoho.com/oauth/v2/auth?access_type=offline (You must add access_type=offline or your access token will not be refreshed and only last 1 Hour)
  • Access Token URL: https://accounts.zoho.com/oauth/v2/token
  • Refresh Token URL: https://accounts.zoho.com/oauth/v2/token
  • Revoke Token URL: https://accounts.zoho.com/oauth/v2/token/revoke
  • Scopes: Enter your required scopes (These can be from any Zoho Application)
  • Scope Delimiter: Comma

Once you have entered all the required information you can click Create Service.

Create a Custom Connection


Now that the service is ready, you can create the custom connection:
  • Click "Create Connection" within your new service.
  • Name the connection and select the scopes you want to include.
  • Click "Create and Connect" and then select "Accept" on the authorisation screen.

Once successfully created, you can use the connection anywhere in the application or use the link name of this connection in Deluge functions to automate tasks across different Zoho apps.

Conclusion

Please reach out to us if you would like some help creating custom connections in your system.

Need Help? Contact us!

Resources