Connections in Zoho Vertical Solutions

Connections

Connections enable you to connect to any of your native Vertical solution or third-party or other Zoho services using OAuth 2.0 authorization. It abstracts the entire OAuth2.0 authorization flow and keeps your code simple, clean, and crisp. Once the Connection is configured and linked to the corresponding third party account, one can easily access the respective APIs in your code by mentioning the Connection's link name, without having to worry about configuration data storage and access token regeneration.

Important Terminologies

Client - The name of your application you want to register with your vertical solution org.
Resource - The application or service that the client is trying to access. In our case, the resource is the third-party service (ex: Dropbox) you are trying to integrate.
Request Token URL - The request token URL is the URL that the client uses to send an authorization request to the resource server. The resource server will then prompt the resource owner (the user) to authorize the request.
Access Token URL - Once the request is authorized by the resource owner, the server sends an access token to the client. This token has to be exchanged every time the clients wants to access the resource data.
Refresh Token URL - Some access tokens are valid only for a limited period of time. When an access token expires, the client has to get another access token from the resource, using the refresh token URL.
Client ID - A unique identifier provided to every client application. This ID is provided by the resource owner.
Client Secret - Every client application has a secret code mapped to it. This is done to prevent unauthorized access to the resource.
Redirect URL - This is the URL to which the end user will be redirected after authorization. The client application will generate a redirect URL automatically.

Connection Types

There are two types of connection.
  1. Default connection
  2. Custom connection
Currently, connection for a vertical service has to be created by individual orgs, as a Custom Connection.

Default Connection

Default connections are pre-built integrations between your vertical solutions org and other Zoho apps or third-party applications.

To create a connection with a default service:
  1. Go to Setup > Developer Space > Connections.
  2. Click Create Connection.
  3. Under Default Services, pick the service you want to integrate your solution with.
  4. In the Connection Details, enter the following details:
    1. Connection name : This will be the display name for your connection. Display name can contain up to 50 characters.
    2. Connection link name : Link names must be unique and can be used in Deluge integration tasks and invoke URL scripts to establish authentication.
      Note : The link name that you provide must satisfy the following conditions:
      1. It must begin with a lower case letter.
      2. It can contain lower case letters, numbers, and underscores (_).
      3. It can contain up to 50 characters.
    3. Choose appropriate scopes, as required.
  5. Click on Create and Connect.
  6. Your connection with a default service will be created and you will be redirected to an Authentication page. An example of Authenticating a Zoho Account page is shown below.

  7. Once you click on connect, you will be redirected to the respective service page.
  8. In the User Permissions window, provide your login credentials, and proceed. Or, click on Allow if you are already logged into the service.
  9. Upon successful authorization, you will be redirected to the Connection Summary page.

Custom Connection

Custom connections extends the ability for users to create integrations between a vertical solution account and any service, that may or may not be in the default serivces.

To create a custom connection:
  1. Go to Setup > Developer Space > Connections.
  2. Click Create Connection.
  3. Choose Custom Services and click Create New Service.
  4. In the Service Details, enter the following details:
    1. Service name: This is the display name of your service. Display name can contain up to 50 characters.
    2. Service link name: Link name of the service to help you to identify your custom service uniquely.
    3. Authentication Type: Choose from the following authentication types based on the desired service's API.
       Authentication Type
       Description
       Fields
      API Key
      This auth type requires you to specify the params for establishing a connection with the desired service. In the next step, you should supply values for these params to perform the integration. For example, if you specify authtoken as param, the next step would be to provide your account's auth token to establish a successful connection.
      On choosing API Key as authentication type, you need to provide values to the following fields:
      - Actual Parameter: Name of the key (as specified in the API documentation of the desired service) against which the parameter needs to be sent.
      - Parameter Display Name: Display name for the parameter. This name will be prompted when you authenticate a connection.
      - Param Type:  This decides how the authentication parameters will be sent along with the URLs specified in the invoke URL scripts. Supported param types: Query string, Form Data, and Header

      Note:
       - You can add as many parameters as required.
       - Parameter could be any type of key that is required for authentication. Example: api-key, user-key, authtoken, apitoken, etc.
       Basic
      This auth type requires you to specify the username and password in the next step. The provided username and password will be automatically encrypted with base64 algorithm and passed as header in the format: basic <encrypted_username>:<encrypted_password>.
      N/A
      OAuth 1
      This auth type requires you to specify the required parameters to perform an OAuth 1 authentication.
      On choosing OAuth 1 as authentication Type, you need to provide values to the following fields:
      - Consumer Key: Consumer key that is issued by the service provider.
      - Consumer Secret: Your consumer secret to authorize your application.
      - Request Token URL: URL to fetch the request token as specified in the API documentation of the desired service.
      - Authorize URL: Authorize URL as specified in the API documentation of the desired service.
      - Access Token URL: URL to fetch the access token as specified in the API documentation of the desired service.
      - Param Type: This decides how the authentication parameters will be sent along with the URLs specified in the invoke URL scripts. Supported param types: Query string, Form Data, and Header.
      OAuth 2
      This auth type requires you to specify the required parameters to perform an OAuth 2 authentication.
      On choosing OAuth 2 as authentication Type, you need to provide values to the following fields:
      - Grant type: Grant type that the desired service uses to perform authorization. You can choose from the supported grant types: Authorization code and client credentials.
      - Client Id: Unique identifier provided to every client application. This ID is provided by the resource owner.
      - Client Secret: Every client application has a secret code mapped to it. This is done to prevent unauthorized access to the resource.
      - Authorize URL: This URL is used to send authorization requests to the resource server. The resource server prompts the resource owner (user) to authorize this request.
      - Access Token URL: Once the request is authorized by the resource owner, the server sends an access token to the client. This token has to be exchanged each time the clients wants to access the resource data.
      - Refresh Token URL: Some access tokens are valid only for a limited period of time. When an access token expires, the client has to get another access token from the resource, using the refresh token URL.
      - Param Type: This decides how the authentication parameters will be sent along with the URLs specified in the invoke URL scripts. Supported param types: Query string, and Header.

      Note: When registering a Zoho client in the required service's developer console, the callback URL needs to be:


  5. Click Create Service to create the service
  6. Once a custom service is created, users can create a connection on that service. To create one, enter the following details.
    1. Connection name : This will be the display name for your connection. Display name can contain up to 50 characters.
    2. Connection link name : Link names must be unique. They can be used in Deluge integration tasks and invoke URL scripts to establish authentication.
      Note: The link name that you provide must satisfy the following conditions.
      1. It must begin with a lower case letter.
      2. It can contain lower case letters, numbers, and underscores (_).
      3. It can contain up to 50 characters 
    3. Scope: (applicable only to OAuth 2 auth type): Provide the Scopes required to perform integration as specified in the desired service's API documentation.
    4. Scope Delimiter (applicable only to OAuth 2 auth type): Delimiter with which the desired service API expects the scopes to be separated.
  7. Click on Create and Connect.
  8. Your connection with the custom service will be created and you will be redirected to an Authentication page.
     An example of Authenticating a Zoho Account page shown below.

  9. Once you click on connect, you will be redirected to the respective service page.
  10. In the User Permissions window, provide your login credentials, and proceed. Or, click on Allow if you are already logged into the service.
  11. Upon successful authorization, you will be redirected to the Connection Summary page.

Using a Connection

After you have created a Connection, you can use it by calling an InvokeUrl task or Zoho's integrations tasks

Performing invokeURL using Connections

When Connections are used to create integrations or connections between a vertical solution account and other applications, the InvokeURL task can be used to perform actions on the integrated application.
Once a connection is created, the sample code in Deluge and JSON for the connection will be available. You may copy the sample and use the same in your code.
To know more about Zoho's invokeUrl task, refer here.

Performing Pre-defined integrations tasks with Zoho services using Connections

With Zoho having its own integrations tasks, users can utilize them in the vertical solutions applications to interact with other Zoho products. Connection is one of the parameters, where users are required to provide the connection link name.
In the following example, we show the syntax of the task used to fetch records from the specified Zoho CRM module.
<variable> = zoho.crm.getRecords(<module_name>, <page>, <per_page>, <query_value>, <connection>);
Here, <connection> has to be replaced with your connection link name.

To know more about Zoho's integrations tasks, refer here.


      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              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.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit

                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsFormstack alternativeEncrypted Forms

                              Wufoo alternativeSecure Forms

                              WCAG



                                        Create. Review. Publish.

                                        Write, edit, collaborate on, and publish documents to different content management platforms.

                                        Get Started Now







                                                          You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                              Manage your brands on social media


                                                                • Desk Community Learning Series


                                                                • Digest


                                                                • Functions


                                                                • Meetups


                                                                • Kbase


                                                                • Resources


                                                                • Glossary


                                                                • Desk Marketplace


                                                                • MVP Corner


                                                                • Word of the Day


                                                                • Ask the Experts


                                                                  Zoho Sheet Resources

                                                                   

                                                                      Zoho Forms Resources


                                                                        Secure your business
                                                                        communication with Zoho Mail


                                                                        Mail on the move with
                                                                        Zoho Mail mobile application

                                                                          Stay on top of your schedule
                                                                          at all times


                                                                          Carry your calendar with you
                                                                          Anytime, anywhere




                                                                                Zoho Sign Resources

                                                                                  Sign, Paperless!

                                                                                  Sign and send business documents on the go!

                                                                                  Get Started Now




                                                                                          Zoho TeamInbox Resources





                                                                                                    Zoho DataPrep Demo

                                                                                                    Get a personalized demo or POC

                                                                                                    REGISTER NOW


                                                                                                      Design. Discuss. Deliver.

                                                                                                      Create visually engaging stories with Zoho Show.

                                                                                                      Get Started Now









                                                                                                                          • Related Articles

                                                                                                                          • Getting Started with Zoho Vertical Solutions Platform

                                                                                                                            The Zoho Vertical Solutions Platform is a low-code development suite that empowers developers to craft tailored solutions. By utilizing our low-code development tools, developers from diverse industries can design custom solutions that address their ...
                                                                                                                          • Workflow Rules in Vertical Solutions

                                                                                                                            Workflow Rules automate actions such as sending email notifications, assigning tasks, and updating record fields based on specified conditions. This feature simplifies processes by automating tasks when certain criteria are met. Key Components of a ...
                                                                                                                          • HIPAA Compliance with Zoho Developer - Vertical Solutions Platform

                                                                                                                            ZohoDeveloper - Vertical Solutions Platform is currently available in developer.zoho.com and developer.zoho.eu and is expected to release in developer.zoho.in and in developer.zoho.com.au.  The Health Insurance Portability and Accountability Act ...
                                                                                                                          • Calls in Vertical Solutions

                                                                                                                            Making and receiving calls are an essential part of a rep's daily activities. They need to track the calls that are made to the customers, schedule calls according to the customer's availability, take down the details of the calls, and make note of ...
                                                                                                                          • E-Sign for Zoho Vertical Apps

                                                                                                                            E-Sign for Vertical Apps is a feature that can be added into your Vertical Solution, enabling users to request electronic signatures for documents. This functionality allows users to send documents to any recipient, both inside and outside your ...
                                                                                                                            Wherever you are is as good as
                                                                                                                            your workplace

                                                                                                                              Resources

                                                                                                                              Videos

                                                                                                                              Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                              eBooks

                                                                                                                              Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                              Webinars

                                                                                                                              Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                              CRM Tips

                                                                                                                              Make the most of Zoho CRM with these useful tips.



                                                                                                                                Zoho Show Resources