Paddle (Edge)

Configure Paddle as a Source in your Pipeline

Perform the following steps to configure your Paddle Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

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

4. On the Select Destination Type page, select the type of Destination you want to use.

5. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, Paddle Source.

   • In the Connect to your Paddle account section, specify the following:

     • Environment: From the drop-down, select the Paddle environment from which you want Hevo to ingest data. This can be Production or Sandbox. The default value is Production. This value must match your API key, and you cannot change it after the Pipeline is created.

     • API Key: The API key that you obtained from your Paddle account. The value is masked in the UI.

6. Click Test & Continue to test the connection to your Paddle Source. Once the test is successful, you can proceed to set up your Destination.

   Note: Hevo checks that the API key matches the selected Environment. If it doesn’t, the test fails.

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Selecting a parent object automatically includes all its associated child objects for replication. However, you can select or deselect the child objects individually.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests all available historical data for the selected objects and loads it into the Destination.

• Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.

For the following objects, Hevo ingests new and updated records in subsequent Pipeline runs:

• Transaction

• Transaction Line Item

• Transaction Payment

Incremental changes are detected using the updated_at field.

For all the other objects, Hevo ingests only new records in subsequent Pipeline runs. Changes to existing records of these objects, such as a renamed product, a canceled subscription, or an approved adjustment, are picked up by a full re-read of the object that Hevo runs once every 7 days. Until then, the Destination shows the earlier values. Events ingested through data refresh are not billable.

If you add a business to an existing customer, Hevo ingests it at the next 7-day re-read, not on the next Pipeline run.

Paddle currently enforces a rate limit of 240 requests per minute per IP address. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

Click to view ERD

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline: