Authenticate with Freshdesk V2

You can authenticate with Freshdesk V2 to create your own instance of the Freshdesk V2 element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Freshdesk V2 platform.

Authenticate Through the UI

Use the UI to authenticate with Freshdesk V2 and create an element instance. Freshdesk V2 authentication follows the typical OAuth 2 framework and you will need to sign in to Freshdesk V2 as part of the process.

If you are configuring events, see the Events section.

To authenticate an element instance:

1. Sign in to Cloud Elements, and then search for Freshdesk V2 in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. Enter the Subdomain and API Key.
5. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
6. Click Create Instance.
7. Provide your Freshdesk V2 credentials, and then allow the connection.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Use the /instances endpoint to authenticate with Freshdesk V2 and create an element instance. If you are configuring events, see the Events section.

To create an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "freshdeskv2"
     },
     "configuration": {
       "subdomain": "<YOUR_SUBDOMAIN>",
       "username": "<YOUR_API_KEY>",
       "filter.response.nulls": true
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
    "element": {
      "key": "freshdeskv2"
    },
    "configuration": {
     "subdomain": "cloudelements",
     "username": "xxxxxxxxxxxxxxxxxxxxx"
    },
    "tags": [
     "Docs"
    ],
      "name": "API Instance"
  }
'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Example Response

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 491,
      "name": "Freshdesk V2",
      "hookName": "Freshdeskv2",
      "key": "freshdeskv2",
      "description": "Add a Freshdesk Instance to connect your existing Freshdesk account to the Help Desk Hub, allowing you to manage your incidents, priorities, statuses, users, etc. across multiple Help Desk Elements. You will need your Freshdesk account information to add an instance.",
      "image": "elements/provider_freshdesk.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": true,
      "beta": false,
      "authentication": {
          "type": "basic"
      },
      "extended": false,
      "hub": "helpdesk",
      "protocolType": "http",
      "parameters": [  ]
    },
    "elementId": 491,
    "tags": [
      "Docs"
      ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
  }