Documentation for TUNE and HasOffer
- Diana Castillo Arroyo (Unlicensed)
Purpose:
The purpose of this walkthrough is to help you set up your Tune and Hasoffer integration
Pre Requisites:
Tune or Hasoffer account
API Key
Before starting, you should take into consideration that we use postbacks to generate conversions, so all of the offers you want to use through the integration must have the conversion Tracking set to Server Postback w/Partner ID
In your WebForce Instance navigate to Integrations
Click on Integrations on the left side menu. Here you can view all your current integrations.
Click the blue plus sign to add additional integrations, in the search by name you can type the tune keyword.
Click Configure under TUNE.
Here are the REQUIRED fields for the integration:
Alias: The alias to identify this integration within the WebForce system.
Domain: You will obtain this value from TUNE.
Security token: You will obtain this value from TUNE.
Log into your TUNE account.
Enter into one of your offers
Click on the default goal.
Grab the domain from the postback conversion url.
If the advertiser is using a security token, get it and paste it into the security token field, keep in mind that if using offers from different advertisers all of them need to have the same security token.
Finally, click on the Save button and you have finished the initial setup.
Postback conversions
Once you have finished the initial setup you have the ability to configure other data points to generate conversions and trigger various goals.
Lead capture
A lead capture occurs when a potential customer fills out the lead form component used in the funnel pages. In order to generate lead conversions in TUNE, you will need to provide an offer ID and a goal ID.
Offer ID
There are multiple ways to define the Offer ID. Here, we have listed them by priority. Basically what this means is that if you provide all or even some of them, the first found will be the one used within WebForce.
Within the editor tool, you can add a hidden input called tune_offer_id to the Lead form component. Simply input the value of the offer ID you want to use.
In the admin, you can go to Funnels > Edit on the desired funnel > Edit on the desired page > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin you can go to Funnels > Edit on the desired funnel > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin, you can go to Integrations and click on View configuration in the TUNE card, Navigate to the Goals tab and define an offer ID in the Funnel section.
Goal ID
There are multiple ways to define the goal ID. Here, we have listed them by priority. Basically what this means is that if you provide all/ or even some of them the first found will be the one used within WebForce.
In the editor, you can add a hidden input called tune_goal_id. Inside put your goal id.
In the admin, you can go to Funnels > Edit on the desired funnel > Edit on the desired page > Metadata. Click on the button to add a new record for the key use tune_lead_goal_id and in the value put the goal ID.
In the admin, you can go to Funnels > Edit on the desired funnel > Metadata. Click on the button to add a new record for the key use tune_lead_goal_id, and in the value put the ID.
Funnel checkout
Every time a successful transaction happens within a funnel at check out. An Offer ID is needed to generate a TUNE conversion.
There are multiple ways to define the Offer ID. Here, we have listed them by priority. Basically what this means is that if you provide all or even some of them the first found will be the one used within WebForce.
In the editor tool, you can add a hidden input to the desired offer called tune_offer_id to the Checkout component. Inside put the value of the offer ID you want to use.
In the admin you can go to Offers > Edit on the desired Offer > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin you can go to Funnels > Edit on the desired funnel > Edit on the desired page > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin you can go to Funnels > Edit on the desired funnel > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin, you can go to Integrations and click on View configuration in the TUNE card, go to the events tab and define an offer ID in the Funnel section.
Funnel upsell
Every time a successful transaction happens in a funnel upsell an Offer ID is needed to generate a TUNE conversion. Additionally, you can provide a goal. If no goal is provided the default goal will be triggered.
Offer ID
In the editor, you can add a hidden input called tune_offer_id to the Upsell component. Inside put the value of the offer ID you want to use.
In the admin you can go to Offers > Edit on the desired Offer > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin you can go to Funnels > Edit on the desired funnel > Edit on the desired page > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin you can go to Funnels > Edit on the desired funnel > Metadata click on the button to add a new record for the key use tune_offer_id and put in the value the ID.
In the admin, you can go to Integrations and click on View configuration in the Everflow card, go to the events tab and define an offer ID in the Funnel section.
Goal ID
There are multiple ways to define the goal ID. Here, we have listed them by priority. Basically what this means is that if you provide all or even some of them the first found will be the one used within WebForce.
In the editor, you can add a hidden input called tune_goal_id to the Upsell component. Inside put the goal ID.
In the admin, you can go to Funnels > Edit on the desired funnel > Edit on the desired page > Metadata click on the button to add a new record for the key use tune_goal_id and in the value the goal ID.
In the admin, you can go to Funnels > Edit on the desired funnel > Metadata click on the button to add a new record for the key use tune_goal_id, and in the value put the id.
Admin/Quote orders
To trigger conversions on admin sells you will need an offer ID, a goal ID can be provided optionally.
Offer ID
In the admin, you can go to Integrations and click on View configuration in the TUNE card, go to the Goals tab and define an offer ID in the Admin section.
Goal ID
In the admin, go to your products, edit in the desired one.
Click in Metadata
Add new metadata, for the key use tune_goal_id_admin. The goal that you put here should be defined (in TUNE) in the offer provided in the previous section.
When providing goals, multiple conversions can be triggered because the goal can be only defined in a product. For example, if you sell an order with 3 products where the third product has a custom goal, this will trigger two conversions. One using the products 1 and 2 with the default goal, and another one using the product 3 with the custom goal.
Shop orders
To trigger conversions on shop sells is needed an offer ID, a goal ID can be provided optionally.
Offer ID
In the admin, you can go to Integrations and click on View configuration in the TUNE card, go to the events tab and define an offer ID in the Shop section.
Goal ID
In the admin, go to your products, edit within the desired product.
Click in Metadata
Add new metadata, for the key use ef_tune_id_shop, and for the value use your goalt ID. Keep in mind the goal that you put here should be defined (in TUNE) in the offer provided in the previous section.
When providing goals, multiple conversions can be triggered because the goal can be only defined in a product. For example, if you sell an order with 3 products where the third product has a custom goal, this will trigger two conversions. One using the products 1 and 2 with the default goal, and another one using the product 3 with the custom goal.
Subscriptions/Recurring payments
A subscription can be created from three different channels Funnel, Admin, or Shop. To trigger conversions on recurring payments an offer ID and a goal ID is needed.
Offer ID
There are multiple ways to define the Offer ID. Here, we have listed them by priority. Basically what this means is that if you provide all or even some of them the first found will be the one used within WebForce.
In the admin got Products > Edit on your desired one > Subscription plans > On the desired one click on the vertical dots > Metadata add new metadata, for the key use tune_offer_id and put in the value the ID.
Depending on the source of the subscription, it will use the global Funnel/Admin/Shop offer ID.
Goal ID
There are multiple ways to define the goal ID. Here, we have listed them by priority. Basically what this means is that if you provide all/ or even some of them the first found will be the one used within WebForce.
In the admin go to Products > Edit on your desired one > Subscription plans > On the desired one click on the vertical dots > Metadata add new metadata, for the key use tune_subscription_goal_id and put in the value the goal ID.
Depending on the source of the subscription, it will use the global Funnel/Admin/Shop goal ID.
Affiliate ID
To be capable of triggering all of the conversions explained before an affiliate ID is also needed. When working with Lead capture/Funnel sells you need to specify it through a parameter in the URL.
For example: https://domain.com/someurl?affid=1
You can set the affiliate id in 4 different parameter names:
affid
affId
aff_id
affiliate_id
When working with Admin/Shop sells the affiliate ID is obtained by recovering the first conversion for that customer.
When working with subscriptions it is obtained by recovering the conversion of the purchase that created the subscription.
If the affiliate ID is not found the conversion won’t be triggered.
How to verify if the Integration is working:
Very important before being able to test, we must have an Affiliate Link ready to use.
Perform a live transaction and a test transaction.
Follow this walkthrough to perform a test transaction: Creating a Test Order
After performing the transaction check your orders
To check a live order go to Orders and select the Order number as shown below
To check a Test order just go to Orders and click the Funnel icon on the top right corner
Once you have selected the Funnel icon the dropdown will appear, just select Test and Apply to view only the Test orders
Check List:
Tune or Hasoffer account
API Key