Freshdesk
Guide to integrate your Freshdesk with Sprinkle
Last updated
Guide to integrate your Freshdesk with Sprinkle
Last updated
Before setting up the datasource, learn about datasource concepts
To learn about Connection, refer
Log into Sprinkle application
Navigate to Datasources -> Connections Tab -> New Connection ->
Select Freshdesk
Provide all the mandatory details
Name: Name to identify this connection
API Key: To get your API key, refer
Sub-Domain: Provide only the subdomain. Example:- https://{SUBDOMAIN}.freshdesk.com
Advance Settings : Refer
Test Connection
Create
Navigate to Datasources -> Datasources Tab -> Add ->
Select Freshdesk
Provide the name -> Create
Connection Tab:
From the drop-down, select the name of connection created in STEP-2
Update
Report Type (Required): Select from the drop-down:
Conversations
Contacts
Roles
Groups
Canned_Response_Folders
Surveys
Satisfaction_Ratings
Time_Entries
Email_Configs
Email_Mailboxes
Products
Tickets
Ticket_Fields
Agents
Skills
Companies
Scenario_Automations
Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
Destination Schema (Required) : Data warehouse schema where the table will be ingested into
Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<datasourcename>_<tablename>
Create
In the Ingestion Jobs tab:
Trigger the Job, using Run button
To schedule, enable Auto-Run. Change the frequency if needed
API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds.
API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.
Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.
Version : It gives information about the version of Freshdesk API being used.
Max Records : Field sets the max limit on the number of records that can be downloaded during each API call.
Incremental Batch Size (In days) : No. of days in one batch for which data is being downloaded during incremental ingestion.
To learn about datasource, refer
Datasets Tab: To learn about Dataset, refer . Add Dataset for each report/dataset that you want to integrate, providing following details
Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. on how to use this field.