DIRECT POST: Ringba to TrackDrive
& Optional Postback of Traffic Source Payout
Written by Rich Nolan
Updated at August 22nd, 2023
Posting Call Data from Ringba to TrackDrive &
(Optional) Postback from TrackDrive to Ringba
Posting Call Data from Ringba to TrackDrive
In Ringba - Create a Pixel 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 data to TrackDrive when a TrackDrive Target is going to receive the call from Ringba (Note: the trigger could also be for calls that couldn’t route to a buyer and the data is going to a TrackDrive Lead to Call Automation Schedule to monetize missed calls).
Name: Add a logical name for this Pixel configuration.
FirePixel On: In this example, we are setting the trigger to “Connected (Answered)” because we are referring to sending data as a buyer answers a call. However, this could be set to “Finalized” and then filter for “Call – Call Length – From Connect” for a value of “0” (indicating a call that didn’t make it to a Target) and send to a lead_token that is associated with a Lead to Call Automation Schedule on TrackDrive.
URL: You can get the URL Endpoint to send the data to using the posting instructions you received from your TrackDrive buyer. You can use either URL since this is a POST and both endpoints will accept a POST protocol. This is the URL to use if you replace the TrackDrive Subdomain:
https://TRACKDRIVE_SUBDOMAIN_HERE.trackdrive.com/api/v1/leads/capture
NOTE:Ensure that you turn on the Advanced Instructions 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 up the body, the JSON Payload is below, just fix the fields that are highlighted, the tokens in square brackets do not change and you use them exactly as denoted.)
{
"lead_token" : "LEAD_TOKEN_FROM_TrackDrive_POSTING_DOCS",
"traffic_source_id" : "TRAFFIC_SOURCE_ID_FROM_TrackDrive",
"caller_id" : "[tag:InboundNumber:Number]",
"ringba_call_uuid" : "[Call:InboundCallID]"
}
The JSON Payload above is the minimum setup needed for a Postback on traffic source conversion; however, any other data you might have can be added to the Body to send other information like first_name, last_name, jornaya_lead_id, etc.
Headers: You do not need anything in this box.
Authentication: You do not need anything in this box.
Tag Filters: You would use “Connection – Target – Id” with either a single or multiple targets as filters for when to fire this pixel to TrackDrive to send data with the call.
POSTBACK: TrackDrive Buyer to Ringba Traffic Source
Postback Conversions from TrackDrive to Ringba
In Ringba - Create a Global Postback for Any Buyer
Ringba has a menu selection at Integrations/Webhooks that will be used to setup a Webhook for the Postback of converted calls. It is easiest to set a Global Postback since the Call UUID is already unique; however, if you want to be more secure, you can set a Webhook for a single campaign or even for a single buyer to ensure the unique token for the Webhook is more secure.
NOTE: A Global Webhook could be use for any Target to post back conversions, this logic is not just for the TrackDrive Integration. In TrackDrive's opinion, you need only to setup one Webhook for Postbacks and it can be given to any Target to do a postback, since they would have to know both the UNIQUE Webhook token you see in the URL AND the exact call_uuid that you sent in a field to a buyer.
From Integrations/Webhooks, click on Create Webhook. Then simply fill in the following values:
NOTE: (even tho you can make custom field names for a webhook in Ringba, TrackDrive sets up a global hook on each client to get back to Ringba, and we are not expecting different field names than EXACTLY what you see below. Our clients tag the number you are given with the ringba_webook_token and if the call also has ringba_call_uuid, the Global Postback Triggers.)
Name: Global Buyer Revenue Postback (or however you wish to name this webhook)
Call Token: call_id
Revenue Token: call_revenue
Fire Conversion: sale_successful=true
This will produce a URL with a unique identifier for the webhook in the URL. You may simply give your TrackDrive Buyer the full URL produced from filling in the form as a Postback to place in TrackDrive.
Example URL: https://webhook.ringba.com/hook/WHbb01eb9114dc46429d7570fa4a6f87fb?call_id=[callUUID]&call_revenue=[conversionAmount]&sale_successful=true
Below is a picture of a Global Revenue Postback Webhook in Ringba:
In TrackDrive - Create a Global Ringba Postback Trigger
TrackDrive has a menu selection at Company/Webhooks where you can place a global trigger to Postback to any call that is from a Ringba Traffic Source and the ringba_call_uuid field has a value. If you have not done so already, copy in the Global Trigger from TrackDrive Templates and then only a few things need to be changed.
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 WEBHOOK: Do a Postback for Ringba Traffic Sources if ringba_call_uuid is populated”.
Once the copy is done, you should not have to edit the Trigger or the Webhook URL in most situations. However, it depends on if it is easier to map the “ringba_webhook_token” here (if the traffic source made a Global Webhook in Ringba, this would be the preferred place to identify this token value), or in each Number you assign to the Ringba Traffic Source (in the case they give unique webhook token values for each number you assign them). You can combine both methods, it all depends on your Traffic Source's configuration in Ringba.
Option 1: Map “ringba_webhook_token” in the URL settings:
Edit the Webhook URL, then edit the “Ringba Webhook Token Field Mapping Group” using the inline menu. Click the “+ New Custom Field Mapping” button to add a New Custom Field Mapping. Then for any Ringba Traffic Source that uses global webhook for buyer revenue postback, set a filter for the traffic source and map the “ringba_webhook_token” to the unique value in the Ringba URL provided.
A picture of mapping the ringba_webhook_token in the Global URL Mappings is pictured below:
Option 2: Set the “ringba_webhook_token” in the Number provided to the Traffic Source:
If your Traffic Source didn't realize that Ringba can use a Global Webhook for Revenue Postback, it is highly suggested you guide them to this document on how to setup a Global Revenue Postback and use Option 1 above. If they have a use case that they do need to give you many Webhook Tokens for various reasons, then is will be more logical to set the “ringba_webhook_token” value in the Number .
A picture of mapping the ringba_webhook_token in a TrackDrive Number is pictured below:
