Zoho Invoice

Help Docs

Connections

Connections are used to connect Zoho Invoice with third party services to access authenticated data. To establish a connection, you will have to provide a Connection Name, Authentication Type, amongst other details. In Zoho Invoice, you can create multiple connections.

Insight: The Connections option is currently available in Custom Functions, Custom Buttons, and Schedulers in Zoho Invoice.

Set up Connections

You can set up a connection from the Deluge editor page. Here’s how:

Deluge

Types of Connections

There are two types of connections in the create connections page: 

Predefined Connections

You can find the predefined connections in the Pick Your Service tab. Predefined connections are the third party services that Zoho Invoice is already connected with. You will have to enter only the basic details required to set up the connection. 

Create Predefined Connections

Predefined Connections New predefined connection

Custom Connections

Custom connections can be found in the Custom Service tab. If you want to connect with other third party services that are not listed under the Pick Your Service category, you can create it in the Custom Service section. You will have to enter specific details such as the Authentication Type, Authentication Specific details and Connection Name of the application that has to be connected.

Create Custom Connections

To create a Custom Service connection, you need to do the following (assuming OAuth 2 as the authentication protocol):

Register an OAuth client:

You can register a new OAuth client from the developer console. The steps on how to register the client will be provided in the help document. While registering the client, you will be asked for a redirect URL. Please provide the following URL: https:/deluge.zoho.com/delugeauth/callback.

Create the connection:

Once a client has been registered, you will have to go to the Custom Service tab and fill in the required details to create the connection:

Fields  Description
Service Name  Name of the service to which you wish to connect. 
Authentication Type  The protocol used for authentication. 
Param Type  The authentication parameter that is added during API calls while making a connection.
Client ID  The unique identification of the client. This can be obtained when registering the client.
Client Secret  It is a secret used by the OAuth client to authenticate to the authorization Server. This can be obtained when registering the client.
Authorize URL  The URL of the page that lists the scopes you have selected. This page prompts the user to grant permission to delegate the access to the user. 
Access token URL  The URL used to generate access tokens from refresh token.
Refresh token URL  The URL used to generate refresh token. 
Connection Name  The name of the connection. The link name is derived from connection name and will subsequently be used in custom script.
Scope  The permissions requested to the third-party service. You will have to provide a comma separated list of OAuth scopes of the third-party app. It’s the list of actions you wish to access.
New Custom Connection

Now the connection has been authenticated and is ready for use. 

Use Connections in Custom Scripts

Once a connection has been authenticated by the admin, it can be used in the custom scripts. In the connection details page where the connections were created, you will find a code snippet that shows how to use that connection to communicate with the third-party service. 

Code Snippet

You can copy and paste this code snippet in the required places of the deluge script.

Was this document helpful?
Yes
No
Thank you for your feedback!
Want a feature?
Suggest