Zoho FSM | Connections

Connections

A Connection is a way to establish authentication between Zoho FSM and other Zoho or third-party services to establish integration between them. Connection supports different authentication types (viz API Key, Basic, OAuth 1.0, OAuth 2.0). Connections will be used while creating Custom Functions.

 Available in Editions: Standard, Professional, Premium

There are three types of connections:
  1. System Connection: The connection used by the built-in integration task, for accessing the data from FSM and other Zoho services (CRM, Projects, Books, etc). Individual internal connections will be created for individual Zoho integration tasks.
  2. Connection using Default Services: You can choose from the already available list of services, provide your credentials, and establish a connection.
  3. Connection using Custom Services: If the desired service is not available in the default services list, you can configure it on your own and connect to it. Details for registering your Zoho Client is mentioned here.

System Connection

The internal connection used for the FSM data manipulation tasks is listed under Internal Connections at Setup > Developer Space > Connections. Ensure that the status of the connection is Connected. The green dot [] indicates that the connection is Connected.


Connection using Default Services

Following are the steps to create a Connection for a Default Service (Zoho FSM):
  1. Navigate to Setup > Developer Space > Connections.
    Only users with the profile Administrator will have this option.
  2. Click Create Connection.
  3. Select the Default Services tab and click on the service to which you want to connect your Zoho Service. In our case, we need to select Zoho FSM.



  4. Enter a Connection Name.
  5. Choose Scopes.
    The following scopes are available for FSM. Select the appropriate scopes as per your requirements.

     ScopeDescription
    ZohoFSM.modules.custom.READ

    ZohoFSM.modules.contacts.READ

    ZohoFSM.modules.accounts.READ

    ZohoFSM.modules.Requests.READ

    ZohoFSM.modules.Estimates.READ

    ZohoFSM.modules.WorkOrders.READ    		Used to retrieve records. Will be used in the following tasks:

    zoho.fsm.getRecords(<module>, <page>, <perPage>, <optionalDataMap>, <connection>);

    zoho.fsm.getRecordById(<module>, <id>, <optionalDataMap>, <connection>);

    zoho.fsm.getRelatedRecords(<relationName>, <parentModuleName>, <id>, <page>, <perPage>, <optionalDataMap>, <connection>);
    ZohoFSM.modules.custom.CREATE

    ZohoFSM.modules.contacts.CREATE

    ZohoFSM.modules.accounts.CREATE

    ZohoFSM.modules.Requests.CREATE

    ZohoFSM.modules.Estimates.CREATE

    ZohoFSM.modules.WorkOrders.CREATE    		Used to create records. Will be used in the following tasks:

    zoho.fsm.createRecord(<module>, <dataMap>, <optionalDataMap>, <connection>);





    ZohoFSM.modules.custom.UPDATE

    ZohoFSM.modules.contacts.UPDATE

    ZohoFSM.modules.accounts.UPDATE

    ZohoFSM.modules.Requests.UPDATE

    ZohoFSM.modules.Estimates.UPDATE

    ZohoFSM.modules.WorkOrders.UPDATE    		Used to edit records. Will be used in the following tasks:

    zoho.fsm.updateRecord(<module>, <id>, <dataMap>, <optionalDataMap>, <connection>);







  6. Click Create and Connect.
  7. Click Accept in the permissions page.
    The connection is created. The Connection Link Name will be used as an argument in the task zoho.fsm.createRecord.


Click here to know the steps for creating a function using the connection of a default service.

Connection using Custom Services

To create a custom connection for Zoho FSM, follow the steps mentioned below:
  1. Navigate to Setup > Developer Space > Connections and click Create Service.



  2. Enter the following details and click Create Service.
    1. A Service Name
      The Service Link Name will be automatically populated.
    2. Authentication Type: OAuth2
    3. Parameter Type: Header
    4. Grant Type: Authorization Code
    5. Generated Client ID, Client Secret
    6. Authorize URL: https://accounts.zoho.com/oauth/v2/auth?access_type=offline&prompt=consent
    7. Access Token URL: https://accounts.zoho.com/oauth/v2/token
    8. Refresh Token URL: https://accounts.zoho.com/oauth/v2/token
    9. The desired Scope.
      Provide a Scope Display Name.



  3. Click Create Connection.



  4. Perform the following and click Create And Connect:
    1. A Connection Name
      The Connection Link Name will be populated automatically.
    2. Select the necessary Scopes.



  5. Click Connect in the authentication page.



  6. Click Accept in the Authorization page.

 In custom functions, where the FSM API is used via the invokeURL task, use this Connection Link Name.
 

Refer to this page for details of how to create custom connections for other services.

Manage Connections

Refer to this page for details on how to edit, revoke, or delete connections.

Register your Application  

To register your application with Zoho FSM:
  1. Go to the API Console.
  2. Click Add Client.



  3. Choose the Client Type as Server-based Applications.



  4. Enter the following details and click Create:
    1. Client Name: FSM
    2. Homepage URL: https://fsm.zoho.com/home
    3. Authorized Redirect URIs:
      For US domain: https://deluge.zoho.com/delugeauth/callback
      For EU domain: https://dre.zoho.eu/delugeauth/callback
      For IN domain: https://deluge.zoho.in/delugeauth/callback
      For AU domain: https://dre.zoho.com.au/delugeauth/callback

You will receive the following credentials:
Client ID: The consumer key generated from the connected app.
Client Secret: The consumer secret generated from the connected app.