What’s supported

Supported actions

This connector supports:

  • 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.
  • Proxy Actions, using the base URL https://api.heyreach.io/api.

Supported Objects

The heyreach connector supports reading from the following objects:

The heyreach connector supports writing from the following objects:

Example integration

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

# 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.
  • Deploy it using the amp CLI.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
  • Start using the connector!
    • If your integration has Read Actions, you’ll start getting webhook messages.
    • If your integration has Write Actions, you can start making API calls to our Write API.
    • If your integration has Proxy Calls, you can start making Proxy API calls.

Creating an API key for HeyReach

  1. Log in to your HeyReach Dashboard.

  2. Navigate to Integrations.

  3. Select Get API Key.

  4. Click New API Key.