Callback parameters
Find a comprehensive list of all callback parameters.
Mandatory Parameters
| Parameter | Type | Description |
|---|---|---|
| [%USER:UID%] | String | Unique User Identifier, passed in by publisher. Max. length is 65 characters. |
| [%VALUE:CURRENCY%] | Float | User Reward in App Currency. You can configure it in the Currency Settings. |
| [%VALUE:USD%] | 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. |
| [%USER:IP_ADDRESS%] | String | IP Address of the user |
| [%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%] | Integer | ID of the completed task's offer. One offer can have many tasks. |
| [%OFFER:TASK:ID%] | Integer | ID of the completed task. |
| [%OFFER:TASK:STATE%] | String | It can only be used when using Stateful Offer Callbacks. One of: NONE, COMPLETED, PENDING, RECONCILED. It isNONE 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. |
| [%OFFER:NAME%] | String | Localized name of the offer. Language is equivalent to what the user saw. |
| [%OFFER: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. |
| [%OFFER:TASK:IAP:USD%] | Float | The USD amount of a single in-app purchase of an app. |
| [%OFFER:TASK:HIDDEN%] | Integer | Shows if the in-app purchase event was visible to the user or not: 0 when the event is visible, 1 when it's hidden. |
| [%OFFER:TASK:TYPE:ID%] | Integer | Find a list of all Type IDs here. |
| [%OFFER:TASK:TYPE:NAME%] | String | Returns the corresponding name to the Type ID. |
| [%OFFER:REJECTION_REASON%] | String | Returns a rejection reason. Find a list of reasons here. |
| [%OFFER:TASK:CONVERTED_AT%] | RFC3339/ISO 8601 | Date and time of the conversion. |
| [%OFFER:IS_LEAD_CREDIT%] | Boolean | Indicates if the rewards were credited by the support team. |
| [%OFFER:DELAY:RECOMMENDED%] | Integer | Recommended (optional) number of days to hold a user's rewards. |
Survey Parameters
| Parameter | Type | Description |
|---|---|---|
| [%ACTIVITY:TYPE%] | String | Type of the callback ("COMPLETE", "SCREENOUT","RECONCILIATION", "START_BONUS") |
| [%SURVEY: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 Additional reasons can be added in the future. |
| [%SURVEY:RATING%] | Integer | Survey Rating from 0 to 5 |
| [%SURVEY:NETWORK:NAME%] | String | Internal Survey Source/Mediation Layer |
| [%SURVEY:LOI%] | Integer | Length of the Survey in minutes. |
| [%COUNTRY%] | String | The Country the User took the survey from as ISO Code. (Example: US, DE, FR) |
| [%SURVEY:ID%] | String | Unique survey id returned in /v2/client/surveys endpoint. Only available if new integration API is used. |
| [%VALUE:PROMISED_USD%] | Float | Used for screenout purposes. Returns the survey’s promised CPI in USD. |
| [%VALUE:PROMISED_CURRENCY%] | Float | Used for screenout purposes. Returns the survey’s promised Reward in the converted currency. |
Magic Receipts Parameters
| Parameter | Type | Description |
|---|---|---|
| [%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 id we give to an offer that the member tried to get awarded for, i.e. if they clicked that this specific offer was on their receipt, and they are attempting to be awarded for it, we create a unique id for this. Or if an offer we are serving matches with an offer on their receipt (without them choosing it), we create an upload offer id for that if they get awarded. |
| [%RECEIPT:REASON:DESCRIPTION%] | String | Returns the reason why a receipt got rejected or approved. |
| [%RECEIPT:REASON:ID%] | Integer | Returns the id of the reason. |
| [%VALUE:EXPECTED:CURRENCY%] | Float | Returns the expected user reward during PENDING, REVIEWING, or RECONCILED state. |
| [%RECEIPT:PENDING_DAYS%] | Integer | The number of days for a PENDING callback to turn into a COMPLETED one. |
Cashback Parameters
| Parameter | Type | Description |
|---|---|---|
| [%CASHBACK:STATE%] | String | One of: COMPLETED, CREATED, ADJUSTED, PENDING |
| [%CASHBACK:MERCHANT:REF%] | String | Returns the merchant ref ID |
| [%CASHBACK:MERCHANT:NAME%] | String | Returns the merchant name |
| [%CASHBACK:EVENT:NAME%] | String | Returns the name of the tracked event |
| [%CASHBACK:ORDER:ID%] | String | Returns the order ID of a purchase |
| [%CASHBACK:REASON%] | String | Reason for adjustments |
| [%CASHBACK:LINE_ID%] | String | The offer line ID |
| [%CASHBACK:REWARD_DELAY_DAYS%] | Integer | Delay in days |
Ban Parameters
| Macro | Description |
|---|---|
| [%BAN:TYPE%] | The demand type affected by the status change. Possible values: surveys, offers. |
| [%BAN:REASON%] | A plain-text explanation for the status change. Intended primarily for internal logging and support purposes. |
| [%BAN:UNTIL%] | The timestamp until which the current status applies. Uses the ISO 8601 format in UTC. This value may be empty. |
| [%BAN:STATUS%] | The user's current status for the specified demand type. Possible values: active, banned, shadow_ban, review, on_hold. |