Create Custom Connector
Navigate to "Create Custom Connector"
Perform the following actions to create the Custom Connector,
-
Navigate to the Micro Services tab.
-
Click +Create New in the top-right corner.
-
Choose Connection and click Pick & Create.
-
Click the CUSTOM CONNECTOR category in the left pane.
-
Click Create New Custom Connector.
Note:
Click here for other methods
to create a custom connector.
-
If you have previously created Custom Connectors, they will be displayed as cards on the Custom Connectors page. Click the +Create New icon in the top-right corner, a builder will appear. Next, follow the steps given in the next section to create your own Custom Connector.
You can also establish a connection by clicking the Custom Connector cards. Learn more.
Create Custom Connector
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 Authentication Type , Authentication Parameters and Scopes.
-
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.
Note:
-Connector name can have only the following special characters * _ - @ / ! : | & ~ \ + and cannot exceed 50 characters.
-Connector name must start with a letter, a number, or an _ (underscore).
-
Description (Optional) is the text box which stores details or more information about the Custom Connector.
Note:
Description can have only the following special characters
, . ( ) - _ * @ / \ ! : | ~ | &
and cannot exceed 255 characters.
-
Click Create Custom Connector. You will be directed to the General section of the Custom Connector builder.
General - Update Basic Connector Details
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.
Note:
-Connector link name must only start with a letter and cannot exceed 50 characters.
-Connector link name must not contain any special characters except _ (underscore)
-
Upload a logo for your Custom Connector.
Note:
3. Click Save & Continue, you will be directed to the Security section.
Note :
-There are two stages in creating a connector: Draft and Ready. The stage of the connector will be shown in the top-right corner.
-Initially, the stage will be marked as Draft. You cannot create connections with the connector in the Draft stage.
-Once you complete all the mandatory authentication details, you can mark it ready by clicking Mark as Ready.
-If a connector is marked as ready, it cannot be reversed back to the Draft stage.
Security - Specify Authentication Details
The security section enables you to set authentication based on your requirement.
-
Choose the required authentication type for your application and click Save & Continue.
|
Authentication Type |
Description |
Fields |
|
Basic |
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.
Note:
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.
|
|
API Key |
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.
Note:
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.
|
|
OAuth2 |
Authentication-OAuth2
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.
Note:
application. Note:
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.
Note:
|
|
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.
Note:
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.
Note:
|
Note:
The following steps are similar for both
API key
and
Basic authentication
types only the
Authentication parameter
fields changes, hence we have considered
API Key
as an example.-
Once you enter the authentication parameter, click Save. Here we have shown Open Weather as an example.
-
You can also change the Authentication Type by clicking the edit icon, as shown below.
Note: Authentication type
can only be changed when the connector is in the Draft stage, losing all connector configurations. Once the connector is marked ready, you cannot change the
Authentication type.
-
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 Add Connection button.
-
For OAuth2, the following page will be displayed where you need to specify the Authentication Parameters and 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.
Add OAuth Scopes (Applicable only for OAuth2 - Optional)
Note:
We strongly recommend that you add scopes to your OAuth connector, even though scopes in OAuth2 are optional.
-
After saving the Authentication Parameters in OAuth2, You will be directed to the OAuth Scopes section or you can also navigate by clicking OAuth Scopes from the left pane.
-
On the next page, click +Add Scope.
-
Fill in the Scope Name and Scope Value. Click Add. Here we considered adding the scopes of Dropbox.
-
Click the Add New button to add more scopes.
-
Click the three horizontal ellipsis to Edit or Delete 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.
-
Click the Mark as Ready button. The stage will be changed from Draft to Ready.
-
Once the connector is marked Ready, You can add connection using Add Connections.
Note:
-You cannot edit or delete scopes once you added connections with the Custom Connector.
-Connections using Custom Connectors should be invoked using Deluge invoke URL task, mentioning the respective action API, for any specific scenario/workflow.
Different ways to navigate to "Create New Custom Connector"
From Manage Custom Connector page
-
Navigate to the Micro Services page and click Manage Custom Connector.
-
Click +Create Custom Connector.
-
If you find the Custom Connectors listed as cards, click the +Create New 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.
From Built-in Connectors Category in Add Connections page
-
Navigate to the Micro Services tab and click +Create New in the top-right corner.
-
Choose Connection and click Pick & Create.
-
Scroll down to the end of the Built-in Connectors page and click +Create Custom Connector.
Note:
You can use the search tab to search for the desired connector. If the connector is not present in the
Built-in Connectors list, you will be prompted with the
+Create Custom Connector
link. You can also click this link to create a new
Custom Connector.
-
Follow the steps given in the Creating your own Custom Connector section to build your own Custom Connector.
Related Topics
- Understand Connectors
-
Manage Custom Connectors
- Understand Connections
- Create and Authorize Connections
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 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 Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Still can't find what you're looking for?
Write to us: support@zohoforms.com
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho SalesIQ Resources
Zoho TeamInbox Resources
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
Display custom action button for specific records
Requirement The custom action button in a report should be visible only for certain records, based on a condition. Use Case An asset request app lets employees raise requests for gadgets or machines. While filling the form, employees can specify ...Create Custom Layout
This page is relevant to list type report only. To create a custom layout for quick view: Navigate to the Design page of report. Select Quick View tab. Click Custom Layout. The Build your Layout window will appear. Click From Scratch. Select Text ...Custom access permissions for app users
Requirement Create custom permissions for an application and assign them to relevant users. Use case In a human resources management application, users need to be assigned with different access levels, based on their designation. For example, ...Disable Custom Actions after n times
Requirement A custom action on a report has to be disabled after it is triggered three times. Use Case We have an app to maintain customer invoices. After an invoice is created, the staff can email the invoice to the customer with the click of a ...Custom card layout for e-commerce app
Requirement Display products in a card layout with a button to add required products to a cart. Use Case An e-commerce business uses an order management app to process orders. Products need to be displayed in a card layout with product images, and ...