Swell

Prerequisites

• An active Swell account from which data is to be ingested exists.

• The API key is available to authenticate Hevo on your Swell account.

• You are logged in as an Admin user to generate or obtain the API key. Else, you can obtain the API key from your administrator. Read Users for information on granting admin privileges to a user.

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

Obtaining the Store ID and API Key

Swell automatically creates a unique store ID for each store. Hevo uses the store ID to identify the store from which to ingest the data, and the API key is used for authenticating Hevo on your Swell account. The API keys you generate in Swell do not expire. Therefore, you can use an existing key or create a new one to authenticate Hevo on your Swell account. Swell recommends creating a separate API key for each application that will be making calls on your behalf. For example, you can use the store ID and one API key for Hevo, to be used across all your Pipelines. However, you can also use the store ID with a different API key for each Pipeline.

Note: You must log in as an Admin user to perform these steps.

Perform the following steps to obtains the Store ID and API Key:

1. Log in to your Swell account.

2. In the left navigation pane, under the ADMIN section, click Developer, and then click API keys.

   

3. On the API access page, copy the Store ID and save it securely like any other password. Use this ID while configuring your Hevo Pipeline.

   

4. To obtain the API key, do one of the following:

   • Create the API key:

     1. On the API access page, scroll down to the Secret keys section, and click Add secret key to generate a new API key.

        

     2. In the New secret key pop-up window that is displayed, select User from the Scope drop-down and provide the Key description for the API key that helps you easily identify it later.

     3. Click Create key.

        

   • Use an existing API key. Click the masked portion of the secret key to reveal it fully.

     

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

Configuring Swell as a Source

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

1. Click PIPELINES in the Navigation Bar.

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

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

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

   

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

   • Store ID: The unique ID of the Store, from which data is to be ingested.

   • API Secret: The secret key that you obtained from your Swell account.

5. Click TEST & CONTINUE.

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