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

# HeyReach

## 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 Heyreach instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.heyreach.io/api`.

### Supported Objects

The heyreach connector supports reading from the following objects:

* [campaign/GetAll](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#4aaf461e-54c4-4447-beb6-eb5ccca53fb3)
* [li\_account/GetAll](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#8a4d2924-d46c-443f-a4df-65216988a091)
* [list/GetAll](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#c8ef68b4-c329-41ae-8298-72f2336bbb78)

The heyreach connector supports writing from the following objects:

* [list/CreateEmptyList](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#69288286-5cfd-4d5b-9a7e-e758ebbdc988)
* [campaign/AddLeadsToCampaignV2](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#9071e40e-3f6f-473c-b107-b07d36c25d29)
* [list/AddLeadsToListV2](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#b1c5d588-09e6-4085-aafc-5a1b3a92d81a)
* [inbox/SendMessage](https://documenter.getpostman.com/view/23808049/2sA2xb5F75#6e32c3b6-bffc-4ea7-8a51-0e6416dad1df)

### Example integration

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

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

## Using the connector

This connector uses API Key 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 HeyReach:

* Create a manifest file using the [example](https://github.com/amp-labs/samples/blob/main/heyreach/amp.yaml).
* 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 an API key.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Calls](/proxy-actions), you can start making Proxy API calls.

## Creating an API key for HeyReach

1. Log in to your [HeyReach Dashboard](https://app.heyreach.io/app/dashboard).

2. Navigate to **Integrations**.

3. Select **Get API Key**.

4. Click **New API Key**.

<img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/heyreach-api-key.gif?s=c3b14eb80b28a34a04bcf28e4b0fa90b" alt="Alt text" width="2522" height="970" data-path="images/provider-guides/heyreach-api-key.gif" />