Real Time Server Callback

Need a real time server callback for each event associated with your Yozio SuperLinks?  Yozio provides a realtime server callback to your server for each event recorded by sending your sever a http get with parameters.

Article Contents

Overview

Yozio provides a realtime server callback to your server for each event recorded by sending your sever a http get with parameters.

Yozio supports the ability for you to have parameters in your server callback URL. If you do, Yozio will append Yozio parameters after all your parameters. However, be sure to avoid conflicts between your parameters and Yozio parameters.

Yozio Parameters

The most up to date copy of Yozio Parameters may be found at the Yozio Console > Real-time Server Callback under Parameters.

  • short_url: Yozio SuperLink path 
  • use_case: Use case you have configured for the Yozio SuperLink 
  • channel: Channel you have configured for the Yozio SuperLink
  • event: Event name (e.g. "impression", "click", "install", "signup", etc)
  • value: Value of the event (e.g. $10 associated with a "payment" custom downstream event). This value may be null.
  • timestamp: Timestamp in microseconds
  • device_id: The assigned Yozio device ID
  • meta_data: Metadata associated with the Yozio SuperLink for which the event is attributed to. Will be returned in Json string.  May be null if no metadata is associated with the SuperLink.
  • country: Country code
  • os: The OS associated with the device the event took place on. Possible values: "ios", "android", "other"
  • device_type: The device type the event took place on. Possible values: "phone", "tablet", "unknown"

Example Request

1
http://your_callback_url?your_parameter1=p1&your_parameter2=p2&event=click&timestamp=1425355586973&meta_data=%7B%22invite%22%3A%22Tom%22%2C%22name%22%3A%22Jerry%22%7D&os=ios&device_type=phone&short_url=kg.c.kW&use_case=Yozio+Testing&channel=Mobile+Web

Setup and Verification

Step 1: Feature Access

The Yozio Real-time Server Callback is available with select pricing plans. To request access to this feature please contact [email protected]

Step 2: Configure the Server Callback URL

Login to the Yozio Console  and navigate to Data Export > Real-time Server Callback. Enter the URL you would like Yozio to callback to your server in order to register every event recorded by Yozio.

Important Note: You may have parameters in your server callback URL. If you do Yozio will append Yozio parameters after all your parameters. However, be sure to avoid conflicts between your parameters and Yozio parameters. A complete and up-to-date list of all Yozio parameters may be found at Yozio Console > Real-time Server Callback under "Parameters"

Step 3: Verify Setup

First, be sure you have a Yozio SuperLink available for testing configuration or create a new SuperLink for testing.  For example, a test SuperLink for our example was configured as follows:

Real time server callback example

Then, click on the Yozio SuperLink you have selected for this test. Check the access log in your own server. If you can catch things like

1
"/?test=yozio&event=click&timestamp=1425355586973&meta_data=%7B%22invite%22%3A%22Tom%22%2C%22name%22%3A%22Jerry%22%7D&os=ios&device_type=phone&short_url=kg.c.kW&use_case=Yozio+Testing&channel=Mobile+Web ",

then your server callback has been set up successfully.