Postback Information
This page describes how a postback works.
What is a Postback?
A postback allows you to receive notifications on your server every time your account receives a conversion. This is necessary in order for you to be able to provide your users with rewards. For example, whenever you receive a conversion, you may wish to be notified what the payout, user ID, and point value is.
We are also able to send you a postback in the case that a lead may be reversed.
Example Postback URL: http://yoururl.com/postback/?conversion_id={conversion_id}&user_id={s1}&point_value={points}&usd_value={payout}&offer_title={vc_title}
We will replace all of the macros, such as {conversion_id}
, with the actual value (such as "4d63afe33875ceeec17dd7eab41b8590a".) On your server, you will read the "conversion_id" GET variable to retrieve this macro's value.
Receiving postbacks
Chargebacks: in order to receive postbacks for chargebacks/reversals, your postback URL must contain the {state}
macro.
Non-payable events: offers can have events that are for informational purposes only, and do not provide a payout. To receive postbacks for these events, your postback URL must contain the {event_id}
macro. The {payout}
value for these event will be 0.
Available Macros
You may add any of the following macros to your postback URLs. They will be replaced with the corresponding values.
Macro
Replaced Value
Variable Type
{s1}
User ID
String or Integer
{source}
Represents the ID of the offer wall or publisher sub-source in the format vc-[int]
-- e.g. vc-123
String
{points}
Number of points/credits the user should be rewarded with
Decimal or Integer
{vc_title}
Title of the offer as it was displayed on the offer wall.
String
{payout}
Amount in USD that you earned for this conversion
Decimal
{state}
This is the state of the conversion. Possible values are:
approved
- the conversion is approved
rejected
- a conversion that was previously pending or approved was reversed
pending
- the user has completed the offer but the conversion will be approved at a later date
If this macro is not present in your postback URL, postbacks will only be sent for approved
conversions.
String
{status}
DEPRECATED VALUE: please use {state} instead.
Value will be 1 for a new approved conversion. If this macro is present in your postback, then the postback will also be resent in the case of a reversed conversion. In that case, the value will change to 0 while all other values will remain the same.
Integer
{offer_id}
ID of the offer as displayed on the AdGate Media dashboard
Integer
{offer_name}
Name of the offer as displayed on the AdGate Media dashboard
String
{event_id}
UUID of the specific event that was converted
String
{event_id_nodash}
Use this event UUID only if your data type does not support dashes.
String
{event_name}
Description of the event as displayed to the user
String
{s2},{s3},{s4},{s5}
Additional subID values that can be appended to your offer wall URL
String
{conversion_id}
Unique ID of the conversion generated by AdGate Media
String
{session_ip}
IP address of the user that completed the offer
String
{date}
Current date of conversion formatted as YYYY-MM-DD
String
{time}
Current time of conversion formatted as HH:MM:SS
String
{ran}
Randomly generated number
Integer
{country}
Two letter country code representing the user's location.
String
{delay}
Delay in minutes before the conversion is approved.
Integer
{recommended_delay}
Recommended delay in minutes before the conversion should be approved.
Integer
{event_type}
ID used to identify the type of the converted event
Integer
{is_lead_credit}
Indicates if the conversion is a lead credit
Integer
All values are URL encoded.
Expected Response
AdGate Media's servers expect an HTTP Status Code 200 from your postback URL. If this response is not received from your URL, we will attempt to resend the postback up to 5 times. There is a 5 minute delay between each attempt.
Security Recommendations
To prevent tampering, it is important that the postback URL that is used is unique to AdGate Media.
For additional security, you may whitelist the following server IP: 52.42.57.125
Testing and Troubleshooting
Testing and Troubleshooting
To test the postback functionality on your AdGate Rewards offer wall, you may enable the "Test Mode" feature in your offer wall settings. Enabling Test Mode will create an offer at the top of your offer wall. This offer will convert immediately upon click for easy postback testing. We do not recommend enabling this feature on a live offer wall.
To troubleshoot any postback issues, you may visit your Postback Reports page here: https://dash.adgatemedia.com/affiliate/reports/postbacks
This page will show a 30 day history of all postbacks on your account.
Last updated