Establish a Connection with a Custom Service

Using the Custom Service option, you can create a Connection with a service that is not listed or configured as a Default Service. Potentially, using this feature, you can create a successful connection with any Zoho or third-party service.

To create a connection, you need to first configure the required service as a Custom Service.

To configure a service as a Custom Service:

  1. Navigate to the Custom Services option under the SERVICES section in the Connections component and click Create Service.

    catalyst_cloudscale_connections_cs_start
  2. Provide a name for the service and choose the required Authentication Type:

    catalyst_cloudscale_connections_cs__auth_type_sel

This choice will decide the manner in which you authenticate the connection request.

You can choose the API Key option if you wish to authenticate the connection request using a uniquely generated string.

  • Choose the required Parameter Type from the drop-down. This option can be used to configure the format type in which the required credentials are going to be passed. catalyst_cloudscale_connections_cs_parameter
  1. Provide the required parameter details in the respective field, and click Create Service to configure the required service as the custom service.

    catalyst_cloudscale_connections_custom_service_apikey_done
  2. Click Create Connection to begin configuring a connection with the custom service you created. Click Create And Connect once you provide a name for your connection. The Connection Link Name input field will be populated automatically.

    catalyst_cloudscale_connections_custom_service_apike_name
  3. Provide the required credentials to the service you configured to authenticate the connection request.

    catalyst_cloudscale_connections_custom_service_apike_logon

Your connection with the Custom Service will be active and live.

catalyst_cloudscale_connections_custom_service_apike_created

From here on, Catalyst will ensure that the Connections component produces the required tokens to keep the connection live. You can now share data and functionality with the custom service.

You can choose the Basic Authentication option if you wish to authenticate the connection request by passing the required credentials using the Query String.

  • You cannot use any other parameter type other than Query String to pass the required credentials, and it will be automatically selected when you select this authentication type. catalyst_cloudscale_connections_custom_ba_name
  1. Click Create Service to configure the required service as the custom service.

    catalyst_cloudscale_connections_custom_ba_done_service
  2. Click Create Connection to begin configuring a connection with the custom service you created. Click Create And Connect once you provide a name for your connection. The Connection Link Name input field will be populated automatically.

    catalyst_cloudscale_connections_custom_service_ba_connection_start
  3. Provide the required credentials to the service you configured to authenticate the connection request.

    catalyst_cloudscale_connections_custom_service_ba_logon

Your connection with the Custom Service will be active and live.

catalyst_cloudscale_connections_custom_service_ba_cs_connection_done

From here on, Catalyst will ensure that the Connections component produces the required tokens to keep the connection live. You can now share data and functionality with the custom service.

You can choose the OAuth2 option if you wish to authenticate the connection request using access tokens based on OAuth2 protocol.

  • Choose the required Parameter Type from the drop-down. This will determine the manner in which you wish to share your tokens.

    catalyst_cloudscale_connections_custom_service_ba_cs_auth2_sel_aparam
  • Select the required Grant Type from the drop-down. This selection will determine the manner in which you will obtain the required access tokens.

    catalyst_cloudscale_connections_custom_service_ba_cs_auth2_sel_granttype
  • Provide the authorizing credentials and URLs based on your requirement.

    catalyst_cloudscale_connections_custom_service_ba_cs_tokens_gen
  • Enter the required Scopes to define the nature of access that connecting with the custom service will offer. You will also need to enter the display names of the scopes in the Scope Display Name input field. This will be the name that is displayed when you select Scopes to configure your connection with the service

    catalyst_cloudscale_connections_custom_service_auth2_cs_scopes

Info:

  • Use the add icon to add more scopes.

  • Use the delete icon to delete a scope.

  1. Click Create Service to establish the custom service.

    catalyst_cloudscale_connections_custom_service_auth2_cs_scopes_created
  2. Click Create Connection to begin configuring a connection with the custom service you created. The Connection Link Name input field will be populated automatically.

    catalyst_cloudscale_connections_custom_service_auth2_cs_connections_name
  3. Select the required scopes from the list of scopes and click Create And Connect.

    catalyst_cloudscale_connections_custom_service_auth2_cs_scopes_sel_con
  4. Perform the required authentication to authorize the connection request.

    catalyst_cloudscale_connections_custom_service_auth2_cs_connect_service_auth

The connection will be made active and live.

catalyst_cloudscale_connections_custom_service_auth2_cs_live

From here on, Catalyst will ensure that the Connections component produces the required tokens to keep the connection live. You can now share data and functionality with the custom service.

Last Updated 2025-05-26 17:57:12 +0530 +0530

ON THIS PAGE

RELATED LINKS

Catalyst Signals