Freshdesk integration summary

Stitch’s Freshdesk integration replicates data using the Freshdesk REST API. Refer to the Schema section for a list of objects available for replication.

Freshdesk feature snapshot

A high-level look at Stitch's Freshdesk (v1.0) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status Released Supported By

Singer Community

Stitch Plan

Free

Singer GitHub Repository

Freshdesk Repository

DATA SELECTION
Table Selection

Unsupported

Column Selection

Unsupported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Unsupported

Table-level Reset

Unsupported

Configurable Replication Methods

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Freshdesk

Freshdesk setup requirements

To set up Freshdesk in Stitch, you need:

  • Administrator permissions in Freshdesk. As Stitch will only be able to replicate data that the authorizing user access to, we recommend that someone with these permissions complete the setup. For example: if the authorizing user only has access to a handful of tickets, Stitch will only be able to access and replicate the data for those tickets.

    Having a Freshdesk administrator create the integration will ensure that Stitch is able to replicate all the data in your Freshdesk account.

Step 1: Retrieve 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.

Step 2: Add Freshdesk as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Freshdesk icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Freshdesk” would create a schema called stitch_freshdesk in the destination. Note: Schema names cannot be changed after you save the integration.

Step 3: Define 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 replicate data beyond Freshdesk’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Freshdesk integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Freshdesk, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Freshdesk table schemas

Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

API endpoint :

listAllAgents

The agents table contains info about the agents in your Freshdesk account.

id
INTEGER

The agent ID.

Reference:

updated_at
DATE-TIME

The last time the agent was updated.

available
BOOLEAN

Indicates if the agent is taking new tickets.

available_since
DATE-TIME

Dependent on the value of the available attribute, this timestamp denotes when the agent became available/unavailable.

occasional
BOOLEAN

Indicates if the agent is an occasional agent.

signature
STRING

The HTML-formatted signature of the agent.

ticket_scope
INTEGER

The ticket permission of the agent. Possible values include:

  • 1 - Global Access
  • 2 - Group Access
  • 3 - Restricted Access

group_ids
ARRAY

The group IDs associated with the agent.

agents (table), group_ids (attribute)

role_ids
ARRAY

The role IDs associated with the agent.

type
INTEGER

The ID of the role.

Reference:

agents (table), role_ids (attribute)

created_at
DATE-TIME

The timestamp when the agent was created.

contact
OBJECT

Details about the contact info associated with the agent.

active
BOOLEAN

Indicates if the agent is verified.

email
STRING

The email address associated with the agent.

job_title
STRING

The job title of the agent.

language
STRING

The language of the agent. en is the default.

last_login_at
DATE-TIME

The timestamp when the agent last logged in.

mobile
STRING

The mobile number of the agent.

name
STRING

The agent’s name.

phone
STRING

The phone number of the agent.

time_zone
STRING

The timezone of the agent.

created_at
DATE-TIME

The timestamp when the agent’s contact details were first created.

updated_at
DATE-TIME

The timestamp of the last time the agent’s contact details were updated.

agents (table), contact (attribute)


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.