Freshdesk

This connector captures Freshdesk data into Estuary collections via the Freshdesk API.

This connector is based on an open-source connector from a third party, with modifications for performance in the Estuary system.

Supported data resources

The following data resources are supported:

• Agents
• Business hours
• Canned response folders
• Canned responses
• Companies
• Contacts
• Conversations
• Discussion categories
• Discussion comments
• Discussion forums
• Discussion topics
• Email configs
• Email mailboxes
• Groups
• Products
• Roles
• Satisfaction ratings
• Scenario automations
• Settings
• Skills
• SLA policies
• Solution articles
• Solution categories
• Solution folders
• Surveys
• Ticket fields
• Tickets
• Time entries

By default, each resource is mapped to an Estuary collection through a separate binding.

Prerequisites

To use this connector, you'll need:

• Your Freshdesk account URL
• Your Freshdesk API key

Configuration

You configure connectors either in the Estuary web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Freshdesk source connector.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
/api_key	API Key	Freshdesk API Key.	string	Required
/domain	Domain	Freshdesk domain	string	Required
/requests_per_minute	Requests per minute	The number of requests per minute that this source is allowed to use. There is a rate limit of 50 requests per minute per app per account.	integer
/start_date	Start Date	UTC date and time. Any data created after this date will be replicated. If this parameter is not set, all data will be replicated.	string

Bindings

Property	Title	Description	Type	Required/Default
/stream	Stream	Resource from the Freshdesk API from which a collection is captured.	string	Required
/syncMode	Sync mode	Connection method.	string	Required

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-freshdesk:v1
        config:
            api_key: xxxxxxxxxxxxxxxx
            domain: acmesupport.freshdesk.com
    bindings:
      - resource:
          stream: agents
          syncMode: incremental
        target: ${PREFIX}/agents
      {...}