Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Connecting Freshdesk

Freshdesk Info
This integration was created by Stitch for Singer, an open-source, composable ETL platform. Check out & contribute to the repo on GitHub.

Freshdesk is currently in Open Beta. The info in this article is subject to change.

Connecting Stitch to Freshdesk is a four-step process:

  1. Retrieve your Freshdesk API Key
  2. Add Freshdesk as a Stitch data source
  3. Define the Historical Sync
  4. Define the Replication Frequency

Prerequisites

To ensure Stitch will able to access all possible data points, we recommend that someone with Administrator permissions - that is, someone who can see and access everything in your Freshdesk account - create and authorize the integration in Stitch. Keep in mind that we will only ever read your data.

Stitch will only be able to replicate the data that the authorizing user has access to. For example: if the user is only allowed to access tickets to which they’ve been assigned, Stitch will only be able to replicate those tickets’ data.

Retrieving Your Freshdesk API Key

  1. Sign into your Freshdesk account.
  2. Click the user menu (your icon) > Profile Settings.
  3. Your API Key will display under the Change Password section of your profile page.

Leave this page open for now - you’ll need it to wrap things up in Stitch.

Adding Freshdesk as a Stitch Data Source

  1. On the Stitch Dashboard page, click the Add an Integration button.
  2. Click the Freshdesk icon.
  3. Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.

    For example, the name “Stitch Freshdesk” would create a schema called stitch_freshdesk in the data warehouse. This schema is where all the tables for this integration will be stored.
  4. In the Subdomain field, enter your Freshdesk site subdomain. For example: if the full URL were stitchdata.freshdesk.com, only stitchdata would be entered into this field.
  5. In the API Key field, paste your Freshdesk API Key.

Defining the Historical Sync

The Sync Historical Data setting will define the starting date for your Freshdesk integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to sync data beyond Freshdesk’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.

Defining the Replication Frequency

The Replication Frequency controls how often Stitch will attempt to replicate data from your Freshdesk integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.

Note that the more often Freshdesk is set to replicate, the higher your row count will be. Even if all the tables in your Freshdesk integration use Incremental Replication, replicating data frequently will increase your usage.

Stitch & Replicating Freshdesk Data
Before setting the Replication Frequency, we recommend checking out the structure & Replication Methods for this integration’s tables. Tables that contain nested structures and/or use Full Table Replication will lead to a higher number of replicated rows.

To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes.

For more tips on reducing your row count, check out the Reducing Your Row Count article.

After setting the Replication Frequency, click Save Integration to wrap things up.

Related

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!