Recurly

Prerequisites

• An active Recurly account with Admin permissions. Read Roles and Permissions for information on granting admin privileges to a user.

• The Recurly private API key is available to allow Hevo to connect to your Recurly account.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

---

Obtaining the API Key

You require an API key to authenticate Hevo on your Recurly account.

Note: You must log in as a user with Admin permissions to perform these steps.

To obtain an API key:

1. Log in to your Recurly account.

2. In the left navigation pane, click Integrations, and then click API Credentials.

   

3. On the API Credentials page, do one of the following:

   • Create an API key

     1. Click Add Private API Key.

        

     2. On the Add Private API Key page, API Key Information section, specify the following:

        • KEY NAME: A unique name for your API key.

        • Read-Only: An option to grant third-party applications, such as Hevo, Read-Only permission to your Recurly data.

          

     3. Click Save Changes. You can view the API key that you created on the API Credentials page.

     4. Copy the API key displayed in the PRIVATE API KEY field and save it securely like any other password.

        

   • Use an existing API key

     Note: You can use either the default API key, which is available in all accounts, or an API key that was previously created in your account.

     1. Click the View () icon next to the API key that you want to use.

        

     2. Copy the API key and save it securely like any other password. Use this key while configuring your Hevo Pipeline.

---

Configuring Recurly as a Source

Perform the following steps to configure Recurly as the Source in your Pipeline:

1. Click PIPELINES in the Asset Palette.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. On the Select Source Type page, select Recurly.

4. On the Configure your Recurly Source page, specify the following:

   

   • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

   • API Key: The private API key that you created in your Recurly account.

   • EU Environment (only visible to users in the Europe region of Hevo): Enable this if your Recurly account is in the European Union (EU) region. Read Data Hosting in Recurly to know about all the regions that Recurly supports.

   • Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 3 Months.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.

---