Skip to main content
Integrations

Integrating Ontraport

Written By Angela L

Last updated 8 months ago

In this tutorial, learn how to integrate with the Ontraport autoresponder service using PayKickstart’s API integration.

In your PayKickstart account, go to Configure → Integrations.


First, you’ll need to integrate on your main integration page.

Inside the Integrations menu, make sure to click on the Available tab.

Then find the Autoresponders category in the filter, and scroll down to locate Ontraport.

You can also search for Ontraport directly within the Search field:

Enable Ontraport by clicking the toggle switch.

Enter your Ontraport Account name, APP ID, and API key, and click Connect.

To find the APP ID and API key, follow these steps:

  1. Use of the Forms API requires an API App ID and API Key. These can be generated within your ONTRAPORT account by going to your Account drop-down menu > Administration > Integrations > ONTRAPORT API Instructions and Key Manager.

  2. Also, be sure to select the appropriate permissions for the key you are about to generate (for example, if a key does not have “add” permissions selected, it will not be able to be used to add type requests.)

Note:

If you have not done so already, you will need to submit a request for access to the API. Once access is granted, you can generate as many API App ID/API Key combinations as you want. For more information on how to generate a key or how to request access, please view their Knowledgebase article.

After connecting your account, you must set up a Trigger to tell PayKickstart when to send customer information to Ontraport.

In the PayKickstart dashboard, go to Configure and select Triggers →

https://app.paykickstart.com/vendor/configure/triggers

Click the + New Trigger button to create a new rule.

Configure the Trigger settings as follows:

  • Status:
    First, toggle the switch at the top to make the trigger ACTIVE.

  • Trigger Name:
    Give your trigger a descriptive name so you can easily identify it later
    (e.g., "Product 1 - New Sale to Ontraport").
     

Select Event(s):
Choose the event that will fire this trigger.
For adding new customers, New sale is the most common choice.

Please note:

Available event options will show clearly only after saving your first trigger.

We recommend choosing the New Sale event when setting up the integration for the first time as it would trigger with any new transaction that is created for the product.

For Ontraport, the currently available and supported events are:

  • New Sale - triggers when a new transaction is created for the product

  • New Trial - triggers when a new trial is started for the product

  • Refund - triggers when a refund is issued to the customer, for the specific product

  • Subscription Cancellation - triggers when a Subscription is cancelled, for the product

  • Pending Cancellation - triggers when choosing to cancel the subscription at the end of the billing period, instead of immediately

  • Cart Abandonment - triggers 15 minutes after the checkout page has been abandoned

  • Subscription Changed - triggers whenever the subscription’s plan has been changed to a different one

IF Condition (The Rule):

This defines the variable that must be included for the trigger to run.

Important: The IF condition must be set to a Product, for the integration to function.

Best Practice Use Case:
We recommend creating a separate trigger for each product.
This makes it easier to manage and troubleshoot specific product integrations if needed, rather than having 1 trigger where all products are selected.

THEN Action (The Result):

This defines what will happen when the IF condition is met.

Please ensure that you have your Lists and Tags created in your Ontraport account.

  • Set the THEN action to: add customer to Email Marketing service.

  • Service: Select Ontraport from the dropdown.

  • Account: Choose the Ontraport account you connected in your Integrations section.

  • Select List: Choose the specific Ontraport list where you want to add the customer.

  • Add Tag: Select a Tag, or multiple Tags you want to apply to the customer in Ontraport (e.g., new customer, subscribed customer, etc.)

Once you have configured the rule, click the Update Trigger button to save your automation.

Now, when a customer purchases your main offer product, they’ll automatically be added to this Ontraport list that you’ve chosen.