This integration is powered by Singer's Freshdesk tap. For support, visit the GitHub repo or join the Singer Slack.
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) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on March 1, 2017 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Unsupported |
Column selection |
Unsupported |
| Select all |
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
- Sign into your Freshdesk account.
- Click the user menu (your icon) > Profile Settings.
- 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
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Freshdesk icon.
-
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_freshdeskin the destination. Note: Schema names cannot be changed after you save the integration.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines 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:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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 reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Freshdesk integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
agents
The agents table contains info about the agents in your Freshdesk account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join agents with | on |
|---|---|
| groups |
agents.id = groups.agent_ids agents.group_ids.type = groups.id |
| satisfaction_ratings |
agents.id = satisfaction_ratings.agent_id agents.group_ids.type = satisfaction_ratings.group_id |
| tickets |
agents.id = tickets.responder_id agents.group_ids.type = tickets.group_id |
| time_entries |
agents.id = time_entries.agent_id |
| roles |
agents.role_ids.type = roles.id |
|
available BOOLEAN |
|||||||||||
|
available_since DATE-TIME |
|||||||||||
|
contact OBJECT
|
|||||||||||
|
created_at DATE-TIME |
|||||||||||
|
group_ids ARRAY |
|||||||||||
|
id
INTEGER |
|||||||||||
|
occasional BOOLEAN |
|||||||||||
|
role_ids ARRAY |
|||||||||||
|
signature STRING |
|||||||||||
|
ticket_scope INTEGER |
|||||||||||
|
updated_at
DATE-TIME |
companies
The companies table contains info about the companies your various customers and contacts belong to.
Custom Fields
If applicable, Stitch will replicate custom fields related to companies in Freshdesk.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join companies with | on |
|---|---|
| tickets |
companies.id = tickets.company_id |
|
created_at DATE-TIME |
||
|
custom_fields ARRAY
|
||
|
description STRING |
||
|
domains ARRAY |
||
|
id
INTEGER |
||
|
name STRING |
||
|
note STRING |
||
|
updated_at
DATE-TIME |
conversations
The conversations table contains info about replies and public/private notes added to the tickets in your Freshdesk account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join conversations with | on |
|---|---|
| tickets |
conversations.ticket_id = tickets.id |
| satisfaction_ratings |
conversations.ticket_id = satisfaction_ratings.ticket_id |
|
bcc_emails
ARRAY |
|
body_text STRING |
|
cc_emails
ARRAY |
|
created_at
DATE-TIME |
|
from_email STRING |
|
id
INTEGER |
|
incoming BOOLEAN |
|
private BOOLEAN |
|
source INTEGER |
|
support_email STRING |
|
ticket_id INTEGER |
|
to_emails
ARRAY |
|
updated_at
DATE-TIME |
|
user_id INTEGER |
groups
The groups table contains info about the groups your agents belong to.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join groups with | on |
|---|---|
| agents |
groups.agent_ids = agents.id groups.id = agents.group_ids.type |
| satisfaction_ratings |
groups.agent_ids = satisfaction_ratings.agent_id groups.id = satisfaction_ratings.group_id |
| tickets |
groups.agent_ids = tickets.responder_id groups.id = tickets.group_id |
| time_entries |
groups.agent_ids = time_entries.agent_id |
|
agent_ids ARRAY |
|
auto_ticket_assign INTEGER, BOOLEAN |
|
business_hour_id INTEGER |
|
created_at DATE-TIME |
|
description STRING |
|
escalate_to INTEGER |
|
id
INTEGER |
|
name STRING |
|
unassigned_for STRING |
|
updated_at
DATE-TIME |
roles
The roles table contains info about the various roles that can be assigned to team members in your Freshdesk account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join roles with | on |
|---|---|
| agents |
roles.id = agents.role_ids.type |
|
created_at DATE-TIME |
|
default BOOLEAN |
|
description STRING |
|
id
INTEGER |
|
name STRING |
|
updated_at
DATE-TIME |
satisfaction_ratings
The satisfaction_ratings table contains info about customer satisfaction survey responses, or satisfaction ratings.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join satisfaction_ratings with | on |
|---|---|
| agents |
satisfaction_ratings.agent_id = agents.id satisfaction_ratings.group_id = agents.group_ids.type |
| groups |
satisfaction_ratings.agent_id = groups.agent_ids satisfaction_ratings.group_id = groups.id |
| tickets |
satisfaction_ratings.agent_id = tickets.responder_id satisfaction_ratings.group_id = tickets.group_id satisfaction_ratings.ticket_id = tickets.id |
| time_entries |
satisfaction_ratings.agent_id = time_entries.agent_id |
| conversations |
satisfaction_ratings.ticket_id = conversations.ticket_id |
|
agent_id INTEGER |
||
|
created_at DATE-TIME |
||
|
feedback STRING |
||
|
group_id INTEGER |
||
|
id
INTEGER |
||
|
ratings ARRAY
|
||
|
survey_id INTEGER |
||
|
ticket_id INTEGER |
||
|
updated_at
DATE-TIME |
||
|
user_id INTEGER |
tickets
The tickets table contains info about the tickets in your Freshdesk account.
Custom Fields
If applicable, Stitch will replicate custom fields related to tickets in Freshdesk.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join tickets with | on |
|---|---|
| agents |
tickets.responder_id = agents.id tickets.group_id = agents.group_ids.type |
| groups |
tickets.responder_id = groups.agent_ids tickets.group_id = groups.id |
| satisfaction_ratings |
tickets.responder_id = satisfaction_ratings.agent_id tickets.group_id = satisfaction_ratings.group_id tickets.id = satisfaction_ratings.ticket_id |
| time_entries |
tickets.responder_id = time_entries.agent_id |
| companies |
tickets.company_id = companies.id |
| conversations |
tickets.id = conversations.ticket_id |
|
cc_emails ARRAY |
|||||
|
company OBJECT
|
|||||
|
company_id INTEGER |
|||||
|
created_at DATE-TIME |
|||||
|
custom_fields ARRAY
|
|||||
|
deleted BOOLEAN |
|||||
|
description STRING |
|||||
|
description_text STRING |
|||||
|
due_by DATE-TIME |
|||||
|
STRING |
|||||
|
email_config_id INTEGER |
|||||
|
facebook_id STRING |
|||||
|
fr_due_by DATE-TIME |
|||||
|
fr_escalated BOOLEAN |
|||||
|
fwd_emails ARRAY |
|||||
|
group_id INTEGER |
|||||
|
id
INTEGER |
|||||
|
is_escalated BOOLEAN |
|||||
|
name STRING |
|||||
|
phone STRING |
|||||
|
priority NUMBER |
|||||
|
product_id INTEGER |
|||||
|
reply_cc_emails ARRAY |
|||||
|
requester OBJECT
|
|||||
|
requester_id INTEGER |
|||||
|
responder_id INTEGER |
|||||
|
source NUMBER |
|||||
|
spam BOOLEAN |
|||||
|
stats OBJECT
|
|||||
|
status NUMBER |
|||||
|
subject STRING |
|||||
|
tags ARRAY |
|||||
|
to_emails ARRAY |
|||||
|
twitter_id STRING |
|||||
|
type STRING |
|||||
|
updated_at
DATE-TIME |
time_entries
The time_entries table contains info about the time entries entered by agents working on tickets.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join time_entries with | on |
|---|---|
| agents |
time_entries.agent_id = agents.id |
| groups |
time_entries.agent_id = groups.agent_ids |
| satisfaction_ratings |
time_entries.agent_id = satisfaction_ratings.agent_id |
| tickets |
time_entries.agent_id = tickets.responder_id |
|
agent_id INTEGER |
|
billable BOOLEAN |
|
created_at DATE-TIME |
|
executed_at DATE-TIME |
|
id
INTEGER |
|
note STRING |
|
start_time DATE-TIME |
|
ticket_id INTEGER |
|
time_spent STRING |
|
timer_running BOOLEAN |
|
updated_at
DATE-TIME |
| Related | Troubleshooting |
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.