Skip to main content

Getting Started

Callbacks

The Callback is the basis by which you can reward your users. The Callback is a GET request that is sent to your processing script upon the conclusion of a transaction - either a complete COMPLETE, screenout TERMINATION, or overquota QUOATAFULL.

This request contains important information about which user needs to be rewarded, what offer was taken, and how much virtual currency they should be paid.

Setup Callback

RapidoReach supports secure hasing on system-to-system callbacks. Please reach out to a RapidoReach account manager to configure the Callback URL. Follow the steps below to complete your setup.

How to create a Processing Script

  1. Create an endpoint that can receive a GET request to its location.
  2. Reward your users for completes and screen-out rewards (if applicable).
  3. Store information in your database
  4. Respond with a 1 if callback received & processed correctly and 0 if you require us to repeat the callback (can be repeated three more times).

Add the Callback to your application

  • Go to Apps section.
  • Select your Application.
  • Click on the Callback section.
  • Click on the Setup Callback button.
  • Enter your Callback URL.
  • Click Save button.

Callback Responses

Sample processing script location (sometimes referring to a php, aspx, or another script depending on your webapp configuration)

app-domain.com/callback

Parameters will be appended with their corresponding variables after the processing script location as follows:

app-domain.com/callback?cmd=transactionComplete&userId=user123-9370-d163590aa9
&amt=100&offerInvitationId=1234&status=C&oiHash=2ef1130cca32cd030141d8935dec0992
&currencyAmt=20000&transactionId=4321&endUserId=user123&offerTitle=TestProject
&useragent=RapidoReach&profiler=&currencyName=Chachingz&offerType=survey
&txnHash=66a2b2987083666c76592d505240748e&program=&transactionSource=iframe&
app-domain.com/callback 
'?cmd=' // QUOTAFULL, COMPLETE, TERMINATION
OfferStatus // 
'&userId=' 
RORuserId  // RapidoReach userId as generated earlier.
'&amt=' 
Dollar_AMT.toFixed(2) // Amount paid in dollars to you for this particular transaction.
'&offerInvitationId=' 
TransactionId  // Enables you to remember for which offer a user has been rewarded for.
'&status=' 
OfferStatus  // Compete - Disqualified - QuotaFull
'&offerHash=' 
offerHash  //32 character hex string = md5(concat(offerInvitationId, applicationKey))
'&currencyAmt=' 
VC_AMT.toFixed(2)  //Payout to user in your virtual currency. Important for screenout rewards.
'&transactionId=' 
TransactionId  //Unique ID representing a single user participating in a single survey/offer,
'&endUserId=' 
endUserId 
'&txnHash=' 
transHash  //md5(concat(transactionId, current TransactionKey))
'&useragent=' 
'Rapidoreach' 
'&currencyName=' 
app.vc_name 
'&offerType=' 
OfferType 
'&deviceType=' 
DeviceType 
'&intergrationMethod=' 
'IFRAME';

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Back to top