> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshdesk

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is supported only for `companies`, `tickets` and `contacts` currently. For all other objects, a full read of the Freshdesk instance will be done per scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://{{.workspace}}.freshdesk.com`.

### Supported Objects

The Freshdesk connector supports reading from the following objects:

* [agents](https://developers.freshdesk.com/api/#agents)
* [business\_hours](https://developers.freshdesk.com/api/#business-hours)
* [canned\_response\_folders](https://developers.freshdesk.com/api/#canned-responses)
* [companies](https://developers.freshdesk.com/api/#companies)
* [company-fields](https://developers.freshdesk.com/api/#company-fields)
* [contacts](https://developers.freshdesk.com/api/#contacts)
* [contact-fields](https://developers.freshdesk.com/api/#contact-fields)
* [email\_configs](https://developers.freshdesk.com/api/#email-configs)
* [groups](https://developers.freshdesk.com/api/#admin-groups)
* [mailboxes](https://developers.freshdesk.com/api/#email-mailboxes)
* [products](https://developers.freshdesk.com/api/#products)
* [roles](https://developers.freshdesk.com/api/#roles)
* [scenario\_automations](https://developers.freshdesk.com/api/#scenario-automations)
* [sla\_policies](https://developers.freshdesk.com/api/#sla-policies)
* [skills](https://developers.freshdesk.com/api/#skills)
* [tickets](https://developers.freshdesk.com/api/#tickets)
* [ticket-fields](https://developers.freshdesk.com/api/#ticket-fields)
* [ticket-forms](https://developers.freshdesk.com/api/#ticket-forms)
* [time\_entries](https://developers.freshdesk.com/api/#time-entries)

The Freshdesk connector supports writing to the following objects:

* [agents](https://developers.freshdesk.com/api/#create_agent)
* [canned\_responses](https://developers.freshdesk.com/api/#create_canned_response)
* [canned\_response\_folders](https://developers.freshdesk.com/api/#create_canned_response_folder)
* [companies](https://developers.freshdesk.com/api/#create_company)
* [company-fields](https://developers.freshdesk.com/api/#create_company_field)
* [contacts](https://developers.freshdesk.com/api/#create_contact)
* [contact-fields](https://developers.freshdesk.com/api/#create_contact)
* [contact-activities](https://developers.freshdesk.com/api/#omnichannel-activities)
* [groups](https://developers.freshdesk.com/api/#create_group)
* [mailboxes](https://developers.freshdesk.com/api/#create_email_mailbox)
* [skills](https://developers.freshdesk.com/api/#create_skill)
* [sla\_policies](https://developers.freshdesk.com/api/#create_sla_policy)
* [thread](https://developers.freshdesk.com/api/#create_a_thread)
* [tickets](https://developers.freshdesk.com/api/#create_ticket)
* [ticket-fields](https://developers.freshdesk.com/api/#create_ticket_field)
* [ticket-forms](https://developers.freshdesk.com/api/#create_ticket_form)

### Example integration

To define an integration for Freshdesk, create a manifest file that looks like this:

```YAML theme={null}
# amp.yaml
specVersion: 1.0.0
integrations:
  - name: Freshdesk-integration
    displayName: My Freshdesk Integration
    provider: freshdesk
    proxy:
      enabled: true
```

## Using the connector

This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Freshdesk:

* Create a manifest file like the [example](#example-integration) above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their username, password and domain.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the correct header required by Basic Auth. Please note that this connector's base URL is `https://{{.workspace}}.freshdesk.com`.