Sigma uses connections to expand your Zoho Services’ third-party support. This is done with the help of OAuth 2.0 or any other basic authentication protocols.
OAuth 2.0
OAuth 2.0 is an industry standard, open source authorisation protocol which is used to gain partial access to a user’s account on an HTTP service. A well-known classical example of this is the sign in screen that requests for partial access to your personal account whenever you try to log in an application using your social media credentials such as Google, or Yahoo.
Say, you have created a tutorial video for your product and hosted on YouTube and you wish to be notified whenever somebody comments . You can write a function to fetch the comments from YouTube. Likewise, connections are used to connect Sigma to a third party app, YouTube in our case via OAuth 2.0 protocol.
Users can either connect with an available service or configure a custom service.
Connect with a default service
To make integration easier, we provide a set of services that are most frequently used by our customers. After configuring the basic details, users can establish a connection.
-
Navigate to Connections module, choose a service and the associated organization, and click
Create Connection
.
-
Under
Pick Your Service
, select a third-party or internal Zoho service.
-
Create an account in the service that you chose, if you do not have one.
-
Configure the service details under the
Connection Details
section.
-
Click
Create and Connect.
-
Enter the required details, such as the Domain ID and user credentials, to establish the connection. Once the authentication is successful, the service will be ready to use.
Alternatively, you can also select
Default Services
under
Services
in the left panel, and select a default service to connect.
-
The scope of the connection varies with each service.
-
For authentication methods using the Basic Auth protocol, configuring the Actual Parameter and Parameter Display Name fields help with the verification process. While establishing the connection, a dialogue box prompts you to enter the configured parameter value. The integration will only be successful if the parameter values match.
-
For authentication methods using OAuth 2.0 protocol, a callback URL must be mentioned in the respective third-party service.
Connect with a custom service
In addition to the services provided, users can also connect with other third-party services. To establish a custom connection:
-
In the Connections page, select
Custom Services
from the left panel and click
Create Service.
-
Under the Custom Service tab, enter the service and connection details.
-
Service details:
-
Service Name: Enter the name of the service.
-
Authentication Type: Select the authentication method used by the third-party service.
-
Fill in the parameter details with respect to the chosen authentication type.
-
Click
Create Service.
-
The Service Summary page displays the details of the service.
-
Click
Create Connection
and enter the connection details.
-
Click
Create and Connect.
-
Once the authentication is successful, the service will be ready to use.
-
The scope of the connection varies with each service.
-
For authentication methods using the Basic Auth protocol, configuring the Actual Parameter and Parameter Display Name fields help with the verification process. While establishing the connection, a dialogue box prompts you to enter the configured parameter value. The integration will only be successful if the parameter values match.
-
For authentication methods using OAuth 2.0 protocol, a callback URL must be mentioned in the respective third-party service.
Edit Connection
Update the existing connection based on your requirement using the edit option.
-
Navigate to
Connections
, hover the mouse over the respective service.
-
Click the
icon to edit the Connection.
-
Make the necessary changes to the connection.
-
Click
Update.
Revoke a connection
If users no longer require an integration, they can revoke the connection.
-
In the
Connections
page, select the service first and then select the connection to be revoked.
-
Click
Revoke.
Upon revoking a connection, the authorization will also be revoked. However, the service will be available in the Connections page and can be authorized any time.
Delete Connection
In case you no longer need the connection that you have created, you can delete the same using this option.
-
Navigate to
Connections, hover the mouse over the respective connection.
-
Click
.
All the Deluge functions that rely on this connection may no longer serve if this function is deleted.
To learn extensively about connections,
click here
.