Skip to main content

​
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 CallRail instance will be done for each scheduled read.
  • Write Actions.
  • Proxy Actions, using the base URL https://api.callrail.com.
  • Subscribe Actions are not currently supported.

​
Supported objects

ObjectReadWrite

​
Example integration

For an example manifest file of a CallRail integration, visit our samples repo on GitHub.

​
Before you get started

To connect CallRail with Ampersand, you will need a CallRail account.

​
Creating an API key for CallRail

  1. Log in to your CallRail account.
  2. Go to Account Settings, then select API Keys under Data Access.
  3. Select Create New API v3 Key and give the key a name.
  4. Copy the key and store it somewhere secure — CallRail displays it only once. See CallRail’s API for more detail.
Your customers enter this API key when they install the integration. Ampersand sends it as Authorization: Token token=<API key>, as described in CallRail’s Getting Started guide. You do not need to collect an account ID from your customer. After the connection is created, Ampersand calls GET /v3/a.json and stores the account’s numeric ID, then uses it in every request path.

​
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 CallRail:
  • Create a manifest file like the example above.
  • Deploy it using the amp CLI.
  • If you are using Read Actions, create a destination.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for their 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 Actions, you can start making Proxy API calls. Note that CallRail paths include the account ID, for example GET /v3/a/{account_id}/calls.json.