Posting Call Data from TrackDrive to Ringba 

&

(Optional) Postback from Ringba to TrackDrive

Posting Call Data from TrackDrive to Ringba

Using Inbound Data Enrichment (IDE) Method

Custom Fields:

NOTE: You can read about the IDE setup on Ringba with their own article here.  Data can also be posted to Ringba using the Real Time Bidding Method as well, which is documented in a different support article.

Both TrackDrive and Ringba allow defining custom fields; for example, first_name, last_name, email, etc., to exchange data between any platform via API.  Ringba uses the term “URL Parameters” and TrackDrive uses “Tokens” as terminology referring to Custom Fields. 

NOTE: It is best practice to define the field names you want to use on any platform and try to stay consistent in naming conventions.  For example, always use “first_name” as the custom field name for First Name, and don’t conform to instructions you get from a publisher or buyer and add “firstname” or “fn” as well because they have used those naming conventions. Any platform will allow you to map your field name to their field name and vice versa.

In Ringba - Create Custom Field Names

Ringba has a menu option under Integrations/URL Parameters to setup your custom fields. To add a new URL Parameter, click the “+ CREATE URL PARAMETER” button.

URL Parameter: This is basically the database name for a field.  Most platforms will not allow a space in a field name, so it is normal to use naming conventions like “first_name” or “social_security_number” so that the field name is more easily read with underscores where a space would belong.  In the example above, the field name “trackdrive_call_uuid” and “trackdrive_subdomain”  are being used to pass the TrackDrive Unique ID for the Call to Ringba, so that the optional step of getting a Postback from Ringba to TrackDrive can use that field name.

NOTE: To see how a TrackDrive names standard field names, you may reference the following Posting Instructions.  On TrackDrive, we try to keep the standard field names at the top, and then vertical specific field names at the bottom.  In the example posting instructions, you will see that the field names related specifically to the Medicare Offer are at the bottom of the example.

Reporting Menu Name: If you need this field to appear on reports or select it in Pixels/Webhooks, the Reporting Menu Name field must be set to “User”.

Report Name: This is the friendly name as it will appear on the Reporting Column Headers.  However, any field you want to use in tag filters to trigger pixels to fire, the URL Parameter Name and the Report Name MUST MATCH or the pixel filters will always say they don't match.

In Ringba - Manufacture IDE Webhook

To get the unique URL to post data into Ringba from TrackDrive, you edit the campaign and scroll down to the Publishers section.  Use the Hyperlink Icon as pictured below to copy the URL you will give to a publisher (aka Traffic Source in TrackDrive terminology).

Example URL: https://display.ringba.com/enrich/1882570683251575656?callerid=<<E.164-CALLER-NUMBER>>&key1=value1&key2=value2. Using the example URL Parameters from above, you would edit this string to be:

https://display.ringba.com/enrich/1882570683251575656?callerid=+1[caller_id_short]&trackdrive_call_uuid=[call_uuid]&first_name=[first_name]&last_name=[last_name]&email=[email]&address=[address]&city=[city]&state=[state]&zip=[zip]&jornaya_leadid=[jornaya_leadid]&trusted_form_cert_url=[trusted_form_cert_url]

NOTE:  The only difference on any webhook URL for the IDE Post Method would be the token that references the number in use for the data enrichment post as shown in red above.  Below you will see where to use this value in the “ringba_enrich_token” as a token associated to the buyer.

In TrackDrive - Setup Ringba Global IDE Data Post Webhook

TrackDrive has a menu selection at Company/Webhooks where you can place a Global Trigger to Post data to Ringba via the IDE Method before calling the buyer.

NOTE: If you already have the Global Webhook in your account, skip this step.  From Company/Webhooks, click on the blue “New From Template” button to find available webhook templates and search for “Ringba”.  You will find a webhook to copy in called “GLOBAL TRIGGER: RINGBA ENRICH: before calling a buyer, send Ringba additional data”.

Once the copy is done, you should not have to edit the Trigger or the Webhook normally.  However, you may edit the Trigger created from the copy, then edit the Webhook URL to make some optional changes as documented below:

Map Lead Data to Custom Values: This section is used to map any data values that your Ringba Buyer may have a different acceptable value than the values you use for the same field in TrackDrive.  Advanced users may also wish to map the “ringba_enrich_token” values here instead of adding an additional token in the buyer as described below.  But this section will need field mappings made in certain situations.  For example: the value of “gender” in TrackDrive is M or F, but your Ringba Buyer may have acceptable values of Male and Female, so you would configure a field mapping to handle that for any buyers who need it.

Webhook Params: The standard Ringba field names and all the standard TrackDrive field names have been configured already; however, the field names being sent to Ringba must conform to the name your Ringba Buyer has setup on the URL Parameters on the Ringba System.  Ringba will only accept data that is defined to be received, but it doesn’t hurt anything to send extra data.  Using Filters, you will be able to map by buyer the field name they want to receive in the IDE post.

Was the Response Acceptable: The settings to ensure Ringba is accepting the data before sending the call have already been set in the copied Global Webhook.  However, if you want to send the call to Ringba even if they don’t accept the data, you need to clear the values in the boxes outlined in the picture above.

In TrackDrive - Triggering the Ringba IDE Global Webhook

To Trigger the Ringba Global IDE Webhook, you simply add the “ringba_enrich_token” to any buyer record using the “Manage Extra Tokens” button as pictured below:

POSTBACK: Ringba Buyer to TrackDrive Traffic Source

 

 

       

 

 

 

Postback Conversions from Ringba to TrackDrive

(Using “auth_token” Authorization)

 

NOTE: Before a buyer can Postback conversion to TrackDrive, in TrackDrive you must add the Buyer to a Team and turn on the API Permission, then on the Calls section, give permission to update the Buyer Converted, Revenue, Traffic Source Converted, Payout, and Contact Fields (optional, only needed if additional data will come in the Postback payload).

 

In Ringba - Setup Postback Pixel to TrackDrive in the Campaign

 

Ringba has a section of the Campaign Setup for Tracking Pixels, you have the option to use existing Pixels or add a new one, for simplicity, we will only discuss adding a new pixel to be used to send the Postback to TrackDrive when a call converts for the Publisher.  NOTE: Once you have a pixel configured for a Publisher Postback, it can be used on any Campaign in Ringba for a Postback to TrackDrive since we are using the “trackdrive_call_uuid” to do the update to the call, which will allow this to work for any call update on any offer.

 

 

Pictured below is a setup for posting data to TrackDrive when the Publisher converts on a call:

 

 

Name: Add a logical name for this Pixel configuration. For example: " TrackDrive Global Postback for Publisher Chris Jones".

 

Fire Pixel On: Select “Payout” as the trigger point for this pixel to fire.  You will want to set two filters as the Trigger for when the Postback will fire to TrackDrive.  The first will be a filter for the Publisher who is sending you the call, and the second will be a filter to ensure the field named “trackdrive_call_uuid” exists in the call data from an IDE or RTB data post from TrackDrive.

 

URL: Below is the URL to use but you MUST replace the TrackDrive Subdomain:

 

https://TrackDrive_Publisher_Subdomain_Here.trackdrive.com/api/v1/calls/update_call/[tag:user:trackdrive_call_uuid]
 

NOTE: The Filter used above to check if the TrackDrive Call UUID exists assumes that you created the URL Parameters to accept the TrackDrive Subdomain (future need to place a single Postback Pixel to all TrackDrive Publishers) and TrackDrive Call UUID as fields.

NOTE: Ensure that you turn on the Advanced Options so you can change to a Post JSON Protocol configuration as pictured.

 

HTTP Method: Select “POST” as the protocol. 

 

Content Type: Select “application/json” as the Content-type header.

 

Body:

 

(for ease in setting this up, the JSON Payload is below, just fix the fields in squiggly brackets. The tokens in square brackets do not change and you use them exactly as denoted.)

{
    "auth_token": "TrackDrive_Auth_Token_From_Profile",
    "buyer_converted": "true",
    "revenue": "[Call:ConversionPayout]",
    "offer_converted": "true",
    "post_call_tokens": {}
}

 

The JSON Payload above is the minimum setup to use to Postback to TrackDrive from Ringba.  However, more data can be appended if available in the Ringba data.  For example, the “external_buyer_forwarded_duration” may be a custom field a TrackDrive user wants back in the hashed “post_call_tokens” values of the Postback.  However, additional data is usually not sent on Postbacks for most tracking purposes, and the example payload above is all you will need.