How to integrate with Ringba

Welcome to our integration guide for setting up Ringba Pixels with NewsBreak. By following the steps below, you will enable accurate event tracking and seamless server-to-server data exchange between Ringba and NewsBreak.

Important Notes:

• In the NewsBreak ecosystem, a Ringba “Pixel” functions as a postback URL.
• Before proceeding, ensure your Ringba campaign is fully configured and active. 
• Since click ID is passed via URL parameter, please ensure your Ringba campaign can capture click ID from the url parameter and connect with User: clickid tag in Ringba. 
• If you are using a third-party tracking platform (e.g., CAKE, Redtrack, Everflow and Volumm), please refer to Ringba’s official integration documentation for platform-specific setup guidance.

Step 1 Prepare your Postback settings on Newsbreak

1. Log into your NewsBreak Ads Manager.

2. Go to Tools → Event Management → Web Events. Click “Create / test event”. 

3. For 3rd Party Tracking service, select Ringba. 

4. Select the event type you want to track (e.g. conversion, purchase, etc.), and indicate if you want to track event value. 

5. NewsBreak will generate instructions and Postback URL template. (https://business.newsbreak.com/tracking/attribute?callback=[tag:User:clickid]&event_type=<EVENT_TYPE>.) The parameters callback (click ID) and event_type are mandatory for all postback events. 

6. Copy and save the Postback URL — it will be entered in Ringba during Step 2.

Note that you must include the macro __CALLBACK_PARAM__ in your ad landing page URL — this will be replaced by NewsBreak with a unique click ID when the user clicks your ad. 

Step 2: Create a pixel in Ringba 

1. Navigate to Integrations > Pixels and click Create Pixel.
2. Configure the pixel settings as follows:
   1. Name: Enter a descriptive name to easily identify this pixel when assigning it to a campaign (e.g., NewsBreak Conversion Pixel).
   2. Fire Pixel On: Select the event that should trigger the pixel. Choose the option that aligns with your tracking requirements. There are 3 event types supported by Newsbreak: 
      1. Incoming — Fired when a call is initiated. Used to measure how many users attempted to call after clicking an ad.
      2. Connected (Answered) — Fired when the call is answered. Used to measure answer rate and call engagement.
      3. Converted — Fired when a call meets your defined conversion criteria (for example, minimum duration or agent disposition). This represents a qualified conversion event.
   3. URL: Enter the destination URL where Ringba should send the postback data. This is the NewsBreak Postback URL generated during step 1. Please make sure to replace the event_type with the correct type of events. 
3. If additional configuration is needed:
   1.  Enable Advanced Options toggle to reveal more fields: 
      1. HTTP Method: Choose the appropriate request type GET. 
      2. Headers: Enter the parameter name ("key") and the parameter value ("value") you want the pixel to send. Use the Token button to choose a call tag for the value field. Click the Add button. Repeat for each parameter you want to include. (Please see the appendix for additional parameter guide)
4. Once all information is complete, save the pixel configuration. 

After saving, you will assign this pixel to the relevant campaign in the next step.

Step 3: Assign the Pixel to the relevant Ringba Campaign

1. In Ringba, navigate to Campaigns, and open the campaign associated with your NewsBreak traffic.

2. Scroll to the Tracking Pixels section and select “Add Pixel.” 

3. Choose the pixel you created in the previous step, then click “Add.”

4. Review and save your campaign settings to ensure the pixel is properly applied.

Step 4: Test the integration in Newsbreak

Before the event can be saved, a successful test must be completed. 

1. On the Event Creation page, paste your landing page test URL into the designated placeholder. Example of landing page url: https://demo.test-domain.com/test_product/?newsbreak_cid=__CALLBACK_PARAM__ 

2. Click “Go Test.” and it will open the landing page testing url. 

3. Go to the landing page and complete the required conversion action (e.g., place a phone call) to trigger the event.

4. Once the event is successfully fired, the test status will show “Passed.”

5. (Optional) In Ringba, navigate to Reports → Call Details → Pixel Fire Event to confirm that the postback was executed and returned a 200-series status code.

6. After the test is confirmed, click “Save” to finalize the event setup.

Set up additional parameters 

Adding additional parameters will help Newsbreak better tracking your conversion and optimize your campaign. This is a list of parameters you can add: