Desktop integration docs

Initial Setup

In your login, there is a self-guided process that guides you through setting up your offerwall placement. On the offerwall page, you enter the fields listed below:

From there, you are provided with your unique offerwall URLs.

Desktop Integration Options

1. Embedding

Once your postback is setup and tested, embed the iFrame code on your website. If you choose this option, we highly recommend making the iFrame size responsive, or at least 1000 pixels high to ensure that users see enough offers when loading the offerwall initially.  If the embedded iFrame is too small, eCPMs and engagement may be lower & desktop integration.

2. Direct Linking

Once your postback is setup and tested, send your users to the Direct URL that includes their unique user ID in their browser. This ensures that all actions are tracked properly, and gives the user the option to leave the window open and continue to come back and earn virtual currency even when not in-game.

Postback Information

This form allows you to set up postbacks (also known as closed loop, S2S, server pixel, callback, etc). This system supports regular postbacks (for offers you run directly), as well as offerwall postbacks, which include virtual currency information.We will post information to the URL via GET variables. You must specify the desired variables and the order in which they should be posted.

Example URL: https://www.mysite.com/myscript.php?campaign=$campaign$&userid=$sid$&status=$status$

Consult your script vendor or other personnel for assistance. SID, SID3 , SID 5 and SID 6 are limited to 200 characters. SID2/UID is limited to 255 characters.

IMPORTANT: If you are setting up a postback for a specific offer wall (virtual currency), don't forget to select a deployment from the list before adding the URL.

Variables for All Postback Types

• $campaign$: The campaign ID number of the offer being posted.
• $name$: The name of the offer being posted.
• $rate$: The commission earned (i.e, 5.75). If the offer is being reversed, this will be a negative number (i.e, -5.75).
  
• $status$: This will be either 1 or 2, for completed or reversed, respectively.
• $actionid$: The network action ID for this lead.
• $ip$: The IP address recorded when the user clicked the offer.
• $timestamp$: UNIX timestamp (UTC) of the conversion.
• $useragent$: Browser user agent used when clicking the offer.
• $tag$: Campaign tag value.
• $country$: Country code of user, ISO 3166-1 alpha-2 format.
• $clicktimestamp$: UNIX timestamp (UTC) of the click.
• $sid$: The SID that you passed to the campaign.
• $sid3$: Additional SID parameter #3.
• $sid5$: Additional SID parameter #5.
• $sid6$: Additional SID parameter #6.

For Offer Wall Only

• $sid$: A string that includes your wall ID, ex. “SFB_1234___” where “1234” is the wall ID
• $currency$: The amount of virtual currency issued. This may be a negative number, indicating a currency revocation (if you opt to pass these along).
• $currencytype$: May be one of the following values:
  1 – Offer completed
  2 – Currency issued by customer service
  3 – Offer reversed (currency revocation – currency will have a negative value)

For Offerwall and Unlock Deployment

• $uid$: The user's unique identifier, which you will give to us when loading the IFRAME
• $offertype$: May be one of the following values:
  0 – Undefined
  1 – Free
  2 – Purchase
  3 – Trial
  4 – Other
  5 – Mobile Apps
  6 – Clicks and Videos
  7 – Studies
  8 – Contest

Variables For Non-Wall (API) Traffic Only

• $sid$: The SID that you passed to the campaign.
• $sid4$: see below
  - Direct Correlation: The $sid4$ placeholder receives the exact sid4 value from the API response, enabling accurate attribution of tier-specific conversions within multi-reward campaigns.
  - Empty Value Handling: The sid4 parameter may contain an empty string, which constitutes a valid event identifier. Your postback processing logic must recognize empty sid4 values as legitimate tier completion events, not as data omissions or system errors.
  - Uniqueness Constraints: The sid4 value maintains uniqueness only within the scope of its associated campaign. To ensure system-wide uniqueness, combine the sid4 value with the $campaign$ identifier in your tracking implementation to prevent identifier conflicts across different campaigns.

Unlock Traffic Only

• $cost$: Cost
• $sku$: SKU
• $credittype$: May be one of the following values:
  1 - Offer completed
  2 - Credit issued by customer service
  3 - Offer reversed
  4 - Credit revoked by customer service

Postback Security

HTTPS URLs are now fully supported and these posts will be made securely to your server.

All posts may originate from one of the following IP addresses:

• 67.205.168.172
• 157.230.64.48
• 104.248.49.78
• 206.189.253.134
• 206.189.231.33
• 66.187.72.90
• 66.187.72.91
  
• 66.187.72.92
  
• 66.187.72.93
• 66.187.72.94
• IPv6: 2604:e880:2::/64
• IPv6: 2604:a880:400:d0::/64

Please configure your postback to only accept posts from these IPs.

Postback Rules

Postback URLs may be disabled by yourself, or at our discretion (malformed or malicious URL, excessive errors, etc.). Please correct any known problems, then click the "Enable" link next to the URL to begin receiving posts again.

Timeout/Error Policy: Our server must be able to connect in 4 seconds or less, and complete the post in 4 seconds or less, for a total of 8 seconds per post. We will attempt to complete the postback every 10 minutes no more than 6 times; our system will then delete that particular postback. You will receive e-mails in case any of these events occur.

Response Body: If the response body consists of the single word FAIL, FAILED, or FAILURE (case insensitive), the postback will be considered in error and retried as per the policy above.

Testing Postback

In your portal in the “Configure Postbacks” section, there is an area to test postbacks without completing an offer to ensure your setup is working.  You will see the following display:

Select the offerwall you’d like to test.  Then, ensure you enter the userID in the SID2/UID field.  The SID3 field is optional and not required, but may be used to pass back more information.  Enter the currency amount you’d like to award, and hit submit, and a postback will be submitted to your system so you can verify it is working properly.