> ## 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.

# HappyFox

## What's Supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported. A full read of the HappyFoxChat instance will be done for each scheduled read.
* [Proxy Actions](/proxy-actions), using the base URL `https://api.happyfoxchat.com`.

### Supported Objects

The HappyFox connector supports reading from the following objects:

* [agents](https://developer.happyfoxchat.com/#get-all-agents)
* [visitors](https://developer.happyfoxchat.com/#get-all-visitors)
* [profiles](https://developer.happyfoxchat.com/#get-all-profiles)
* [departments](https://developer.happyfoxchat.com/#get-all-departments48)
* [canned-responses](https://developer.happyfoxchat.com/#get-all-canned-responses)
* [custom-fields](https://developer.happyfoxchat.com/#custom-fields)
* [triggered-chats](https://developer.happyfoxchat.com/#get-all-triggers)

### Example integration

For an example manifest file of an HappyFox integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/happyfox/amp.yaml).

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

```YAML theme={null}
# amp.yaml
specVersion: 1.0.0
integrations: 
  - name: proxy-happyfox
    displayName: HappyFox
    provider: happyfox
    proxy:
      enabled: true
```

## Using the connector

This connector uses **API Key authentication**, so you do not need to configure a Provider App before getting started. (Provider Apps are only required for providers using the **OAuth2 Authorization Code grant type**.)

To integrate with HappyFox:

* Create a manifest file similar to the example above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component, which will prompt the customer for an API key.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API key provided by the customer. Please note that this connector's base URL is `https://api.happyfoxchat.com`.

## Creating an API key for HappyFox

1. Log in to your [HappyFox account](https://app.happyfoxchat.com/b/login) and head on over to **Apps**.
2. In **Apps**, Navigate to **Goodies** and select **Rest API**.
3. In **Rest API**, click **Manage**, where you can create new API keys.
4. In **Manage**, click **Generate a new API token** and API Key Configuration Modal will appear.
5. Enter a Name for the API key, configure the required access permissions, and click **Generate**.

<img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/happyfox.gif?s=20161efbf512e2d398817d8863b61d85" alt="Generate Token" width="800" height="338" data-path="images/provider-guides/happyfox.gif" />