Connectors / Service / Freshdesk

An online cloud-based customer service software providing helpdesk support with all smart automations to get things done faster. (updated: 1657717826111)

Freshdesk

Freshdesk helps your team focus on what matters the most - delivering great support.

Overview

Freshworks, formerly Freshdesk, is a software as a cloud-based, customer service engagement company and helpdesk solution. It is designed to help you & your agents manage incoming requests through some automation options and respond to your customers.

Authentication

When using the Freshdesk connector, the first thing you will need to do is go to your Tray.io account page, and select the workflow you wish to work on. Once in the workflow builder itself, search and drag the Freshdesk connector from the connectors panel (on the left hand side) onto your workflow.

With the new Freshdesk connector step highlighted, in the properties panel on the right, click on 'New Authentication' which is located under the 'Settings' heading.

freshdesk-auth

This will result in a Tray.io authentication pop-up window. The first page will ask you to name your authentication, and state which type of authentication you wish to create ('Personal' or 'Organisational').

freshdesk-popup-1

As you can see, the next page asks you for your 'Domain' and login credentials. Depending on your use case, you will see two different secondary page options. 'Email and Password' requires a combination of your account login details, whereas 'API' needs only the an 'API Key'.

freshdesk-popups-page-2

The 'Domain' is the subdomain of the of your Freshdesk dashboard when you login. For example, if your dashboard is located at mydomain.freshdesk.com, your domain would be mydomain.

If you choose to login using an API Key, navigate to your Freshdesk dashboard and click on your profile picture in the top-right corner. Click 'Profile settings':

freshdesk-get-api-key-1

On the next page, you will see a box called 'Your API Key' in the top-right, which will contain your API Key.

freshdesk-get-api-key-2

Once you have added these fields to your Tray.io authentication popup window, click on the 'Create authentication' button. Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the Freshdesk connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Short summary of what the example below will work through, followed by a numbered list of steps with a brief description of each section. Your steps will essentially become your navigation list on the right hand side.

The steps will be as follows:

  1. Setup manual trigger and list your Freshdesk tickets.

  2. Add your second connector to get the ticket ID's.

The final outcome should look like this:

freshdesk-final

1 - Setup trigger

Once you have created and named your new workflow, and selected the 'Manual Trigger' as your trigger option, add a 'Freshdesk' connector in your second step from the connectors panel on the left.

Set the operation to 'List tickets'. You will notice that there are several 'Filter by' and 'Sort by' options if you wish to be more specific (such as 'Requester ID', 'Email', 'Company ID' etc).

freshdesk-step-1

There are also two mandatory fields right at the bottom of the input options. Your 'Per page' field should be pre-populated for you (set at 20), but feel free to change it as you see fit. as with the 'Page'

We recommend you update any calls to use pagination as standard.

freshdesk-pagination

Your output should look similar to this:

freshdesk-output-1

2 - Get ticket

Add another step to the 'Freshdesk' connector, set the operation to 'Get ticket'. Set the 'Ticket ID' to the ID of one of the projects, by using a JsonPath as shown in the example: $.steps.freshdesk-1.results[0].id.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.

freshdesk-step-2

Click 'Run Workflow'. Open the Debug tab and you should be able to see the successful output with information about your chosen profile displayed like in the example below:

freshdesk-output-2

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

2.0

List email configs ddl

Create company

Create a company

Create contact

Create a contact

Create note

Create a note on a ticket

Create ticket

Create a ticket

Delete company

Delete a company. Deleting a company does not delete the contacts that are associated with it. However the association will be removed. A company cannot be restored.

Delete contact

Delete a contact permanently (this is NOT the soft delete option as shown in the Freshdesk API documentation)

Delete note

Delete a note (also known as a conversation) on a ticket

Delete ticket

Delete a ticket by its ID.

Get company

Retrieve a single company by its ID

Get contact

Retrieve a single contact by their ID

Get ticket

Get a ticket by ID

Get user info

Gets information about the authenticated user

List products ddl

List account tier DDL

List agents

Retrieve a list of agents.

List agents ddl

List companies

Retrieve a list of companies

List companies ddl

List company fields

Retrieve a list of company fields

List contact fields

Retrieve a list of all contact fields

List contacts

Retrieve a list of contacts

List contacts ddl

List email configs

Retrieve a list of email configs.

List groups

Retrieve a list of groups.

List groups ddl

List health scores DDL

List industries DDL

List languages DDL

List products

Retrieve a list of products.

List ticket conversations

Retrieve a list of ticket conversations (conversations are notes and replies on a ticket)

List ticket fields

Retrieves a list of ticket fields.

List tickets

Retrieve a list of tickets. Can be filtered.

List ticket satisfaction ratings

Retrieve a list of ticket satisfaction ratings

List ticket time entries

Retrieve a list of ticket time entries by Ticket ID

List ticket types ddl

List timezones DDL

Restore ticket

Restore a ticket by its ID.

Update company

Update a company. Arrays sent will overwrite existing arrays.

Update contact

Update a contact. Arrays sent will overwrite existing arrays.

Update note

Update a note (conversation)

Update ticket

Update a ticket by its ID.

Upload contact avatar

Upload an avatar for a contact