Perform the following actions to create the Custom Connector,
Navigate to the Micro Services tab.
in the top-right corner.
CUSTOM CONNECTOR category in the left pane.
Create New Custom Connector.
You can also establish a connection by clicking the Custom Connector cards. Learn more.
The following major configurations are necessary to create a Custom Connector:
General defines the basic information of your Custom Connector, such as Connector name , Connector link name , Description, and Logo.
Security defines the authentication settings of the Custom Connector, such as
Continuing from the previous instructions, enter the Connector Name and Description for your Custom Connector.
Connector Name is the display name of the connector you want to create.
Description (Optional) is the text box which stores details or more information about the Custom Connector.
Create Custom Connector.
You will be directed to the General section of the Custom Connector builder.
The General section consists of the basic details of the Connector.
The Connector name, Connector link name and Description will be auto-populated from the initial page. You can also edit them by clicking on the respective field.
Upload a logo for your Custom Connector.
3. Click Save & Continue, you will be directed to the Security section.
The security section enables you to set authentication based on your requirement.
Choose the required authentication type for your application and click
Save & Continue.
This requires you to specify the keys as mentioned in the target services API docs. These connector configurations will be prompted during the connection authorization phase, where you need to key-in the values for the parameters (username and password). They will be automatically encrypted with base64 algorithm and passed as header in the format: basic <encrypted_value>
Parameter Name : Display name of the field which will be prompted when you authorize a connection.
Parameter Key : API key as specified in the target services API documentation against which the parameter value needs to be sent. This Key will be prompted to the user with the mentioned Parameter Name during connection authorization.
This allows you to connect with the third party APIs by authenticating with an API key. It acts as a unique identifier for authentication purposes.
Parameter Name : Display name for the parameter. This name will be prompted when you authorize a connection.
Parameter Key : Key (as specified in the API documentation of the desired service) against which the parameter value needs to be sent.
Note: The Parameters Key is a placeholder values and it will be prompted with the given Parameter Name to the user during the connection authorization.
Parameter Location : Decides how the authentication parameters will be sent along with the URLs specified in the invoke URL script. Supported parameter types are Query String, Form Data, and Header.
OAuth 2.0 is an authorization mechanism that gives limited access to user data on a web server. An OAuth 2.0 server issues an access token that the applications can use to access protected resources on behalf of the resource owner.
Grant type : Refers the way to access the protected resources from the target server.
Note: As of now, only Authorization Code type is supported.
Token URL : URL to fetch the access token as specified in the API documentation of the desired service.
Revoke Token URL : URL to revoke specified OAuth2 access or refresh token. A revoke token request causes the removal of the client permissions associated with the specified token.
Refresh Token URL : URL to access new access tokens, when the current access token becomes invalid or expires.
Note: The URL should be in a standard format with
Bearer Name : Text that acts as a prefix in authentication header for the API request.
Expiry Time : Time (in seconds) at which the access token expires. The default expiry time will be 3600 seconds.
OAuth Scopes (Optional) - This limits the level of access given to the user via access token.
Scope Display Name :
The display name of the third-party Scope.
Scope Value : The level of access that you are requesting for the third-party service.
Scope Delimiter : Delimiter with which the desired service API expects the scopes to be separated.
Once you enter the authentication parameter, click
Here we have shown
as an example.
You can also change the
by clicking the edit icon, as shown below.
Once you complete entering the authentication details, mark the connector as ready.
The stage has been changed from Draft to Ready.
Once marked Ready, You will be able to add connection using the
For OAuth2, the following page will be displayed where you need to specify the
Advanced Parameter. Here we have shown Dropbox
as an example.
For Advanced Parameter, the values in the fields are defaulted as Bearer for Bearer Name and 3600 for Expiry Time. You can modify these values, if required.
Click Save & Continue. Mark the connector as ready to use it in connection. You can also add optional scopes before marking as ready, refer to the steps in the next section to know more.
After saving the
in OAuth2, You will be directed to the
section or you can also navigate by clicking OAuth Scopes
from the left pane.
On the next page, click
Fill in the
Scope Value. Click
Add. Here we considered adding the scopes of
button to add more scopes.
Click the three horizontal ellipsis to Edit
a specific scope record in the table.
If you want to delete multiple scopes, mark it by checking in the checkbox and click
Delete, as shown below.
You can search for the specific scope by entering the scope name or scope value on the Search tab.
Mark as Ready
button. The stage will be changed from
Draft to Ready.
Once the connector is marked
Ready, You can add connection using
Navigate to the Micro Services
page and click
Manage Custom Connector.
+Create Custom Connector.
If you find the Custom Connectors listed as cards, click the
icon in the top-right corner to create a Custom Connector.
Follow the steps given in Creating your own Custom Connector section to build your own Custom Connector.
Navigate to the
tab and click
in the top-right corner.
Pick & Create.
Scroll down to the end of the Built-in Connectors page and click
+Create Custom Connector.
Follow the steps given in the Creating your own Custom Connector section to build your own Custom Connector.
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
Write to us: firstname.lastname@example.org
Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.
Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.
Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.
Make the most of Zoho CRM with these useful tips.