Connections

Connections

Overview

The first step while performing an integration is to create a connection. Connections are used to specify the third party service with which your Zoho Service will be integrated, along with other details like the Connection Name, Authentication Type etc. Details mentioned in each Connection will be used to execute the invoke url task accordingly. For example, if we create a Connection with Service Name "Twitter" and Connection Name "Twitter Connection", the invoke url task will identify that the integration is to be performed with Twitter and it will use the connection name "Twitter Connection" while performing the task. You can create a brand new custom connection or select from one of the connections provided by default.

Steps to create a Connection

To create a Connection, you can select one from the default connections, or you create a new custom connection:

Create a default connection

  • Navigate to the Connections page and under Pick your Service, click on the service you need to connect your Zoho Service with.
  • Under Connection Details, specify a Connection Name and the Scope. Click on Create and Connect.

    Note:

    • The scope and its availability may vary across different services. 
    • For Basic Auth Type, you have to specify required params. In the next step, you have to give values for those params to perform the integration. For example, if Username and Password are the specified params, the next step would be to provide the Username and Password credential for a successful connection.
    • For oauth2 Auth Type, you have to specify callback url in the respective third party service.
  • A User Permissions dialog will pop up, provide your login credentials and proceed. Or click on Allow if you are already logged into the Service.
  • A summary page displaying the Connection summary will be displayed. Click on esc on the top right corner to go back to the Connections page.
  • Upon succesful authorization, the Connection will get created and will be listed in your Connections page under Own Connection.
  • Hover the cursor over the Connection to edit, revoke or delete the Connection.

Create a custom connection

  • Navigate to the Connections page, and click on Create Your Own under Custom Service.
  • Specify the Service Details and Connection Details. Click on Create and Connect.

    Note:

    • The scope and its availability may vary across different services.
    • For Basic Auth Type, you have to specify required params. In the next step, you have to give values for those params to perform the integration. For example, if Username and Password are the specified params, the next step would be to provide the Username and Password credential for a successful connection.
    • For oauth2 Auth Type, you have to specify callback url in the respective third party service.
  • A User Permissions dialog will pop up, provide your login credentials and proceed. Or click on Allow if you are already logged into the Service.
  • A summary page displaying the Connection summary will be displayed. Click on esc on the top right corner to go back to the Connections page.
  • Upon successful authorization, the Connection will get created and will be listed in your Connections page.
  • Hover the cursor over the Connection to edit, revoke or delete the Connection.

Points to Remember

  • Basic and oauth1 supports three param types (query string, form data, Header) whereas oauth2 supports only header param type. 
  • You can create two connections for the same service

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohodeluge.com