Callback parameters
Find a comprehensive list of all callback parameters.
Mandatory parameters
| Parameter | Type | Description |
|---|---|---|
| [%UID%] | String | Unique User Identifier, passed in by publisher. Max. length is 65 characters. |
| [%VAL%] | Float | User Reward in App Currency. You can configure it in the Currency Settings. |
| [%RAW%] | Float | Complete payment in USD, paid to the publisher. |
| [%TX%] | String | Transaction ID. Use this to prevent double-booking. |
| &hash=[Hash] | String | Always attached: Hash of the complete URI (HEX encoded SHA-1 HMAC) with the App Secret. We recommend using this to verify your callbacks. Read more about it here. |
General parameters
| Parameter | Type | Description |
|---|---|---|
| [%APP:TOKEN%] | String | Returns the token of your placement/app. |
| [%IP%] | String | IP Address of the user |
| [%FSCORE%] | String | Fraud level of the user for the current callback. One of: GOOD, MEDIUM, BAD |
| [%REF%] | String | Reference ID can be used to look up the transaction ID of the COMPLETE or COMPLETED callback. |
Offer parameters
| Parameter | Type | Description |
|---|---|---|
| [%OFFER_ID%] | String | ID of the completed task's offer. One offer can have many tasks. |
| [%OFFER_NAME%] | String | Localized name of the offer. Language is equivalent to what the user saw. |
| [%OFFER_STATE%] | String | It can only be used when using Stateful Offer Callbacks. One of: NONE, COMPLETED, PENDING, RECONCILED.It is NONE if stateful offer conversion callbacks are disabled (this is the default). If they are enabled, however, it indicates the latest state of the offer conversion. |
| [%TASK_ID%] | String | ID of the completed task. |
| [%TASK_NAME%] | String | Localized name of the task. Language is equivalent to what the user saw. |
| [%OFFER:TITLE%] | String | Returns the anchor name of an offer. |
| [%OFFER:DELAY%] | Integer | Returns the user reward delay in minutes. |
Additional parameters for offer ban callbacks
| Parameter | Type | Description |
|---|---|---|
| [%BAN_REASON%] | String | Returns the reason for a user ban. |
| [%BAN_STATE%] | String | Returns ACTIVE or BANNED. |
Survey parameters
| Parameter | Type | Description |
|---|---|---|
| [%TYPE%] | String | Type of the callback ("COMPLETE", "SCREENOUT","RECONCILIATION", "START_BONUS") |
| [%REASON%] | String | Explains the reason for a screenout. It can be one of the following: NONE: The user faced a screenout during the client survey ERROR: Something went wrong before the user joined the client survey. QUALITY: The user faced a screenout due to quality issues CLICK: The user faced a screenout during the qualification process |
| [%RAT%] | Integer | Survey Rating from 0 to 5 |
| [%NET%] | String | Internal Survey Source/Mediation Layer |
| [%LOI%] | Integer | Length of the Survey in minutes. |
| [%CAT%] | String | Category of the Survey. |
| [%COUNTRY%] | String | The Country the User took the survey from as ISO Code. (Example: US, DE, FR) |
| [%DELAY%] | Integer | Delay in seconds for which BitLabs withholds a callback to the publisher. In most cases this is zero. |
| [%V2SID%] | String | Unique survey id returned in /v2/client/surveys endpoint. Only available if new integration API is used. |
Magic Receipts parameters
| Parameter | Type | Description |
|---|---|---|
| [%MAGIC_RECEIPT_STATE%] | String | It can only be used when using Stateful Magic Receipts Callbacks. One of: COMPLETED, PENDING, RECONCILED, REVIEWING |
| [%RECEIPT:OFFER:ID%] | Integer | Returns the offer ID |
| [%RECEIPT:OFFER:NAME%] | String | Returns the offer name |
| [%RECEIPT:UPLOAD:ID%] | Integer | Returns an ID that is associated to an upload |
| [%RECEIPT:UPLOAD:OFFER:ID%] | Integer | Returns the offer ID |
| [%MAGIC_RECEIPT_REASON%] | String | Returns the reason why a receipt got rejected or approved. |
| [%MAGIC_RECEIPT_REASON_ID%] | Integer | Returns the id of the reason. |
Updated about 2 months ago