Skip to main content

EverFlow Integration (old version)

  • Updated

Everflow Integration 

 

Purpose:

The purpose of this walkthrough is to help you set up your EverFlow Integration.

 

Pre Requisites:

  • Alias: The alias to identify this integration within the WebForce system.
  • Domain: You will obtain this value from Everflow.
  • Key: You will obtain this value from Everflow.
  • Network ID: You will obtain this value from Everflow.
  • Advertiser ID: You will obtain this value from Everflow. Right now we can only work with one advertiser per account.

Note: Each piece of this integration needs to be completed as this is how information from WebForce is fed into Everflow and data from Everflow is fed back into WebForce. This is the integration walkthrough. If you are looking on how to complete your tracking links, click here!

 

Everflow setup and configuration: https://www.loom.com/share/7be10213ab9841a4a6b894b0b7e963af

 

  1. In your your WebForce Instance navigate to Integrations 
  2. Click on Integrations on the left side menu. Here you can view all your current integrations. Integration_1_.png
  3. Click the blue plus sign to add additional integrationsInetgration_2_.png
  4. Click Configure under Everflow Screen_Shot_2021-09-08_at_4.06.08_PM.png
  5. Here are the REQUIRED fields for the integration: 

    1. Alias: The alias to identify this integration within the WebForce system.

    2. Domain: You will obtain this value from Everflow.

    3. Key: You will obtain this value from Everflow.

    4. Network ID: You will obtain this value from Everflow.

    5. Advertiser ID: You will obtain this value from Everflow. Right now we can only work with one advertiser per account.

  6. Log into your Everflow Account 
  7. tracking_links_1.png
  8. Ad your network ID which can be located under the Control Center > Configuration 
  9. new_everflow_.png
  10. Your Network ID is listed under the general tab. Copy this and add it to the Network ID field in WebForce. new_everflow_2_.jpeg
  11. In the same screen naviagte to the Domains tab, copy the primary one and paste it into the Domain field in WebForce.
  12. Add ALIAS for your Integration
  13. Go back to your main account screen
  14. Screen_Shot_2021-09-08_at_3.58.37_PM.png
  15. Screen_Shot_2021-09-08_at_4.00.19_PM.png
  16. Add the copied API Key from Everflow into the Key field 
  17. Next, to grab the Advertiser ID you will go to Advertisers > Manage new_everflow_3.jpeg
  18. Copy the ID and paste it into the Advertiser iD field in WebForce
    1. If the advertiser has a verification token, copy it and put it in the Verification token field.

    1. Finally, click on the Save button and you have finished the initial setup.

Post Back Events 

Once you have finished the initial setup you have the ability to configure other data points to generate conversions and trigger various events. 

 

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 Everflow, you will need to provide an offer ID and an event ID (normal event ID or advertiser event 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. 

  1. Within the editor tool, you can add a hidden input called ef_offer_id to the Lead form component. Simply input the value of the offer ID you want to use.

  2. new_everflow_5_.png

  3. 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 ef_offer_id and put in the value the ID.

  4. new_everflow_6_.png

  5. 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 ef_offer_id and put in the value the ID.

  6. In the admin, you can go to Integrations and click on View configuration in the Everflow card, Navigate to the events tab and define an offer ID in the Funnel section.everflow_7_.png

Event ID

There are multiple ways to define the Event 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. 

  1. In the editor, you can add a hidden input called ef_event_id (normal event) or ef_adv_event_id (advertiser event) to the Lead form component. Inside put the value of the ID.new_everflow_8_.png

  2. 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 ef_lead_event_id (normal event) or ef_adv_lead_event_id (advertiser event) and in the value put the ID.

  3. 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 ef_lead_event_id (normal event) or ef_adv_lead_event_id (advertiser event), and in the value put the ID.

  4. In the admin, you can go to Integrations and click on View configuration in the Everflow card, go to the events tab, and in the Lead capture advertiser event id field put your advertiser event ID.new_everflow_9_.png

Funnel Checkout 

Every time a successful transaction happens within a funnel at check out. An Offer ID is needed to generate an Everflow 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. 

  1. In the editor tool, you can add a hidden input to the desired offer called ef_offer_id to the Checkout component. Inside put the value of the offer ID you want to use. new_everflow_10_.png

  2. 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 ef_offer_id and put in the value the ID. new_everflow_11_.png

  3. 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 ef_offer_id and put in the value the ID.

  4. 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 ef_offer_id and put in the value the ID.

  5. 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.new_everflow_12_.png

 

Funnel upsell

Every time a successful transaction happens in a funnel upsell an Offer ID is needed to generate an Everflow conversion. Additionally, you can provide an event or an advertiser event. If no event is provided the base event will be triggered.

 

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. 

  1. In the editor, you can add a hidden input called ef_offer_id to the Upsell component. Inside put the value of the offer ID you want to use.

  2. new_everflow_13.png

  3. 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 ef_offer_id and put in the value the ID.new_everflow_14_.png

  4. 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 ef_offer_id and put in the value the ID.

  5. 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 ef_offer_id and put in the value the ID.

  6. 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.

  7. new_everflow_15_.png

Event ID

There are multiple ways to define the Event 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. 

  1. In the editor, you can add a hidden input called ef_event_id (normal event) or ef_adv_event_id (advertiser event) to the Upsell component. Inside put the value of the ID.

  2. 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 ef_upsell_event_id (normal event) or ef_adv_upsell_event_id (advertiser event) and in the value put the ID.

  3.  
  4. new_everflow_16_.png

  5. 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 ef_upsell_event_id (normal event) or ef_adv_upsell_event_id (advertiser event), and in the value put the id.

Admin/Quote orders

To trigger conversions on admin sells you will need an Offer ID, an event ID can be provided optionally.

Offer ID

  1. 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 Admin section.new_everflow_17_.png

Event ID 

  1. In the admin, go to your products, edit in the desired one.

  2. Click in Metadata

  3. Add new metadata, for the key use ef_event_id_admin(normal event) or ef_adv_event_id_admin (advertiser event) and for the value use your event ID. The event that you put here should be defined (in Everflow) in the offer provided in the previous section.

When providing events, multiple conversions can be triggered because the event can be only defined in a product. For example, if you sell an order with 3 products where the third product has a custom event, this will trigger two conversions. One using the product 1 and 2 and the base event, and another using the product 3 with the custom event. 

 

Shop orders

To trigger conversions on shop sells is needed an offer ID, an event ID can be provided optionally.

Offer ID

  1. 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 Shop sectionnew_everflow_18_.png

Event ID

  1. In the admin, go to your products, edit within the desired product.

  2. Click in Metadata

  3. Add new metadata, for the key use ef_event_id_shop(normal event) or ef_adv_event_id_shop (advertiser event) and for the value use your event ID. Keep in mind the event that you put here should be defined (in Everflow) in the offer provided in the previous section.

When providing events, multiple conversions can be triggered because the event can be only defined in a product. For example, if you sell an order with 3 products where the third product has a custom event, this will trigger two conversions. One using the product 1 and 2 and the base event, and another using the product 3 with the custom event

 

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 an event 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. 

  1. 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 ef_offer_id and put in the value the ID.

  2. Depending on the source of the subscription, it will use the global Funnel/Admin/Shop offer ID.new_everflow_19_.png

Event id

There are multiple ways to define the Event 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. 

  1. 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 ef_subscription_event_id (normal event) or ef_adv_subscription_event_id (advertiser event) and put in the value the ID.

  2. Depending on the source of the subscription, it will use the global Funnel/Admin/Shop event or advertiser event ID

  3. .new_everflow_20_.png

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

mceclip1.png

 

To check a Test order just go to Orders and click the Funnel icon on the top right corner

mceclip2.png

 

Once you have selected the Funnel icon the dropdown will appear, just select Test and Apply to view only the Test orders

mceclip3.png

 

Check List:

  • Alias: The alias to identify this integration within the WebForce system.
  • Domain: You will obtain this value from Everflow.
  • Key: You will obtain this value from Everflow.
  • Network ID: You will obtain this value from Everflow.
  • Advertiser ID: You will obtain this value from Everflow. Right now we can only work with one advertiser per account.

 

Related articles

Powered by Zendesk