Integrating Clickbank

Welcome, Clickbank vendors!

As a company that got our feet wet so many years ago with product creation on the Clickbank marketplace, we salute you.

In this guide, we will walk you through the steps to properly add your Clickbank vendor account to Campaign Refinery so all real-time events can be added and processed in Campaign Refinery to add/update your contacts as their status with your vendor account changes.

Let's start

Step 1

Go to "Settings">"Global Settings">"Integrations."

• In the left-hand navigation, you'll see an option for "Settings" with a sub-menu of "Global Settings", then you'll see a tab called "Integrations".
• Here you'll be able to add credentials from your Clickbank vendor account, as well as grab your unique API Notification URL that you will need to place inside of your Clickbank account to it sends all the data you'll need for this integration to work properly.

Step 2

Entering Vendor Information

• You'll need to configure a few settings to get it added to Campaign Refinery.

These items are:

Integration Title

• What do you want to call this integration inside of your Campaign Refinery account to make it really clear what Clickbank account it's for? It may be the same as your Vendor ID, or something that reads more clearly.
• For example, in our screenshot below we chose "Contest Domination" which is a more descriptive title than our offical Vendor ID of "contestdom".

Vendor ID - Nickname

• This is the vendor ID you set up in Clickbank and is included in all of your checkout links. In our case, this was "contestdom" but you'll want to use the official Clickbank vendor ID you created when opening your account with them.
• This is also likely the username you use to login to your Clickbank account.

• Vendor Secret Key

Once you are logged in, click in "Vendor Settings" in the top navigation, then make sure you are on the default "My Site" sub-menu.

Then, scroll down until you reach the "Advanced Tool" section (it should be about 2/3rd of the way down the page).

In this box you'll see an option for "Secret Key", go ahead and copy this key and paste it into the "Vendor Secret Key" portion of your Campaign Refinery integration options.

Don't have a secret key?

If your account is new or you haven't done an integration like this before, your account may be blank for the "Secret Key" section under vendor settings.

Should this be the case for you, you can click "Edit" for the "Advanced Tools" section of your vendor settings to get the following screen:

Once in here, you can generate any string of letters and numbers you'd like to be your self-generated secret key. Click save changes and also put the exact same key (case sensitive) into your Campaign Refinery integration settings as well.

Active Status

Make sure this box is set to "Yes" to make the integration active. In the future, if you ever want to stop your Campaign Refinery account from receiving these events from Clickbank, you can change this to "No" under the edit option for the integration.

Step 3

Generate API Notification URL

• Once you've entered all the information for your Clickbank integration, it's time to generate the API Notification URL, which is as simple as clicking "Save" on the box containing your Clickbank details.
• Doing so will add the integration to the right of the box in a list of your other integrations (if you had others prior to adding Clickbank). You should now see a URL starting with "https://app.campaignrefinery.com/clickbank/catcher?a=...
• Make sure you copy the entire URL string, including the long key that likely wraps to two lines in this area.

Step 4

Add API Notification URL to Clickbank & Verify

• Once you've copied the notification URL from inside Campaign Refinery, jump back into Clickbank and scroll down to "Advanced Tools", then click "Edit" in the top right of that section.

Once you are in this section, make sure you have at least one open value out of your two default "Instant Notification URL" section.

Don't worry if you aren't a developer or don't fully understand the Yes/No questions being asked. We did the hard technical work here for you, so you can select "Yes" to the following questions (which should be all of them):

• Have you reviewed the Instant Notification release notes? YES
• Do you have programming experience or access to a programmer? YES
• Do you understand what a HTML FORM POST to a URL is? YES
• Do you understand what URL parameters are? YES
• Do you understand what a Secret Key is? YES
• Do you understand the effects of Response Code Monitoring? YES
• Do you understand the advantage of using SSL? YES

After selecting "YES" to all of their questions, you'll need to review the Terms of Use by reading them thoroughly, and if you agree select the box "I understand and agree to the Terms of Use.", at that point you can click "SAVE CHANGES & REQUEST API ACCESS".

Once your access has been granted, you can continue with the rest of the integration instructions below.

Go ahead and paste in the URL you copied from Campaign Refinery. At the time of this writing, we developed against Version 7.0, but there may be future versions available you can test against. But the integration is proven to work very reliably with version 7.0.

After pasting in the URL, you'll notice that the "TEST IPN" button becomes red, and some additional text comes up warning you that it is "Unverified. You must test this IPN to enable functionality."

Simply click the button with red text that says "TEST IPN" to satisfy this requirement.

Once you've successfully tested the IPN, your settings should look like this:

Click Save Changes to save this and exit this screen.

Optional: Map Custom Fields

Are you wanting to collect more than just name and email? Perhaps you want the billing/shipping address, phone number or some other value collected during checkout to be added to your contact record.

Clicking the button labeled "Map" under "ACTIONS" will give you these exact options.

Once in here, you can map any existing custom fields you have in your Campaign Refinery account to potentially imported Clickbank data.

It's nice if you already have the custom fields setup before doing this step, so if you don't have a field yet set up that you'd like to use just head on over to the "Contacts" > "Custom Fields" first to create space in your account for what you'd like to record.

Step 5

Create Clickbank Automations

• Now that you have your Campaign Refinery and Clickbank accounts ready to talk to each other, and have optionally configured any custom field data you'd like to map when new contacts are added, you're ready to set up automations for that incoming data.
• We encourage you to use your Campaign level automations for this, as it's a great way to stay organized when your account grows to more products, vendors, etc. So head on over to a campaign, then open up the "Automations" tab for this next step.

Click the "+Automation Rule" in the top right of this section to set up a new automation rule.

In this section, you'll want to set the trigger to "an API integration event is detected", then select "Clickbank" from the drop-down.

Your action can be whatever you'd like, such as starting a sequence or adding a tag. For the sake of this tutorial, we will go with "add a tag".

Click <Continue > to continue to the next step.

Step 6

Configure Automation Options

• Now you'll be presented with your available Clickbank integrations (if this is your first, then only one will be listed).

Event Trigger Types

• Next, you'll want to select from the available events that you want to process. As of this writing there are 19 options for event types you can create an automation for, but this may expand or contract in the future depending on what Clickbank adds.

As of this writing, your EVENT options are:

SALE

• The purchase of a standard product or the initial purchase of recurring billing product.

BILL

• A rebill for a recurring billing product.

RFND

• The refunding of a standard or recurring billing product. Recurring billing products that are refunded also result in a "CANCEL-REBILL" transactions.

CGBK

• A chargeback for a standard or recurring product.

INSF

• An eCheck chargeback for a standard or recurring product.

CANCEL-REBILL

• The cancellation of a recurring billing product. Recurring products that are canceled do not result in any other action.

UNCANCEL-REBILL

• Reversing the cancellation of a recurring billing product.

SUBSCRIPTION-CHG

• A product change for an existing subscription, made through a Master account or through the Orders API.
• The transaction type header also includes the original and new product SKUs in the following format:
• SKU <Old SKU>-><New SKU> The Product

ABANDONED_ORDER

• An abandoned order. Any fields that the customer filled out are included. Fields not filled out by the customer are balnk. NOTE - This type of transaction is sent only if Cart Abandonment is enabled. See the cart Abandonment article for more.

CUSTOMER_AUTH_FAILURE

• An authorization failure for a customer's recurring payment.

CUSTOMER_EMAIL_UPDATE

• An update to a customer's email address.

CUSTOMER_UPDATE_CC_NOTIFICATION

• An update to a customer's payment method.

PURCHASE_DETAILS_EMAIL_RESPONSE

• A resending of a customer's receipt email.

TEST

• A test transaction triggered during configuration.

TEST_BILL

• A rest rebill for a recurring billing product.

TEST_RFND

• A test refund of a standard or recurring billing product.

TEST_SALE

• A test purchase of a standard or recurring billing product.

CANCEL-TEST-REBILL

• A test recurring product cancellation.

UNCANCEL-TEST-REBILL

• A test cancelation reversal for a recurring product.

Step 7

Vendor item/product IDs (Optional)

• If you would like an event to trigger when any item/product happens, then leave this field blank.

However, if you'd like to specify a specific item/product, you can put the name of it here.

• Example item/product ID: pro1
• Example event type: SALE

The idea here is that you can use the item/product IDs to only fire when those specific products are triggering an event. That way, if you add other products to your vendor portfolio later, they won't automatically be included in this automation.

Automation Rule Status

The last step to make sure everything is running is to set the rule status to "On". By default, this setting is turned "Off" as to not accidentally run something right away unless you intend it to run.

Click "Save Automation Rule" and you should be off to the races!