Freshdesk ON THIS PAGE
Freshdesk is an online cloud-based customer support software providing help desk support.
Freshdesk integration replicates data using the Freshdesk REST API .
See the
Schema section for a list of objects available for replication.
Feature snapshot
A high-level look at this connector, including useful links, and supported features.
Preparing for authentication To access your data, you need to authenticate the connection with your account credentials.
Information note Make sure that the account you use has read access to the tables you want to fetch.
Creating the connection For more information, see Connecting to SaaS applications
Fill in the required connection properties. Provide a name for the connection in Connection name .
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create .
Connection settings Setting Description Data gateway
Select a Data Movement gateway if required by your use case.
Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway . If you have another subscription tier and do not want to use Data Movement gateway , select None .
For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement
Start Date Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.
Subdomain You can find your subdomain in the URL of your Freshdesk account. If the URL is your-org-name.freshdesk.com , the subdomain is your-org-name .
API Key API key.
Information note Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 1.
Depending on your destination, table and column names may not appear as they are outlined below.
agents
The agents table contains info about the agents in your Freshdesk account.
agents table foreign keys 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
agents table schema
available
BOOLEAN
available_since
DATE-TIME
contact
OBJECT
This is a nested data structure:
active: BOOLEAN created_at: DATE-TIME email: STRING job_title: STRING language: STRING last_login_at: DATE-TIME mobile: STRING name: STRING phone: STRING time_zone: STRING updated_at: DATE-TIME
created_at
DATE-TIME
group_ids
ARRAY
This is a nested data structure.
id
INTEGER
occasional
BOOLEAN
role_ids
ARRAY
This is a nested data structure.
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.
companies table foreign keys Join companies with on tickets companies.id = tickets.company_id
companies table schema
created_at
DATE-TIME
custom_fields
ARRAY
This is a nested data structure:
name: STRING value: STRING
description
STRING
domains
ARRAY
This is a nested data structure.
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.
conversations table foreign keys Join conversations with on tickets conversations.ticket_id = tickets.id satisfaction_ratings conversations.ticket_id = satisfaction_ratings.ticket_id
conversations table schema
bcc_emails
ARRAY
This is a nested data structure.
body_text
STRING
cc_emails
ARRAY
This is a nested data structure.
created_at
DATE-TIME
from_email
STRING
id
INTEGER
incoming
BOOLEAN
private
BOOLEAN
source
INTEGER
support_email
STRING
ticket_id
INTEGER
to_emails
ARRAY
This is a nested data structure.
updated_at
DATE-TIME
user_id
INTEGER
groups
The groups table contains info about the groups your agents belong to.
groups table foreign keys 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
groups table schema
agent_ids
ARRAY
This is a nested data structure.
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.
roles table foreign keys Join roles with on agents roles.id = agents.role_ids.type
roles table schema
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.
satisfaction_ratings table foreign keys 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
satisfaction_ratings table schema
agent_id
INTEGER
created_at
DATE-TIME
feedback
STRING
group_id
INTEGER
id
INTEGER
ratings
ARRAY
This is a nested data structure:
question: STRING value: INTEGER
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.
tickets table foreign keys 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
tickets table schema
cc_emails
ARRAY
This is a nested data structure.
company
OBJECT
This is a nested data structure:
company_id
INTEGER
created_at
DATE-TIME
custom_fields
ARRAY
This is a nested data structure:
name: STRING value: STRING
deleted
BOOLEAN
description
STRING
description_text
STRING
due_by
DATE-TIME
email
STRING
email_config_id
INTEGER
facebook_id
STRING
fr_due_by
DATE-TIME
fr_escalated
BOOLEAN
fwd_emails
ARRAY
This is a nested data structure.
group_id
INTEGER
id
INTEGER
is_escalated
BOOLEAN
name
STRING
phone
STRING
priority
NUMBER
product_id
INTEGER
reply_cc_emails
ARRAY
This is a nested data structure.
requester
OBJECT
This is a nested data structure:
email: STRING id: INTEGER mobile: STRING name: STRING phone: STRING
requester_id
INTEGER
responder_id
INTEGER
source
NUMBER
spam
BOOLEAN
stats
OBJECT
This is a nested data structure:
closed_at: DATE-TIME first_responded_at: DATE-TIME resolved_at: DATE-TIME
status
NUMBER
subject
STRING
tags
ARRAY
This is a nested data structure.
to_emails
ARRAY
This is a nested data structure.
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.
time_entries table foreign keys 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
time_entries table schema
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
