Pipe Freshdesk Data to CSV in PowerShell

The CData Cmdlets Module for Freshdesk is a standard PowerShell module offering straightforward integration with Freshdesk. Below, you will find examples of using our FreshDesk Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Freshdesk Data

FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

• Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
• APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.

$conn = Connect-FreshDesk  -Domain "$Domain" -APIKey "$APIKey"

Selecting Data

Follow the steps below to retrieve data from the Tickets table and pipe the result into to a CSV file:

Select-FreshDesk -Connection $conn -Table Tickets | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTicketsData.csv -NoTypeInformation

You will notice that we piped the results from Select-FreshDesk into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

Deleting Data

The following line deletes any records that match the criteria:

Select-FreshDesk -Connection $conn -Table Tickets -Where "Status = 2" | Remove-FreshDesk

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Freshdesk, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyTicketsUpdates.csv | %{
  $record = Select-FreshDesk -Connection $FreshDesk -Table Tickets -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-FreshDesk -Connection $freshdesk -Table Tickets -Columns ("Id","Name") -Values ($_.Id, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-FreshDesk -Connection $freshdesk -Table Tickets -Columns ("Id","Name") -Values ($_.Id, $_.Name)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!