{"__v":12,"_id":"5433307ab7eae9080053eb03","category":{"__v":22,"_id":"542998547a6b690800768072","pages":["542a3de5e677b0080050898f","544e8298de6bac1000236fe9","542998547a6b690800768074","542ab90154d88d140075fbd4","5433300867f20a080097a04b","5433302067f20a080097a04d","544e7ae6de6bac1000236fb5","54330b4990d63b1c0030c129","543da24b31ca981a00a6ffe7","54333238a807e208003e72d2","544e8305bd51b9080037f9cb","54332b234aeeef0800410a73","5433306067f20a080097a051","543db19f31ca981a00a70053","543d31d6a10ab32000b3aa70","54a1f0af50465f1f00bfa3e8","54cfc5925ff7e617002bbda5","54f4f09158e9df0d00917b3e"],"project":"542998547a6b69080076806e","version":"542998547a6b690800768071","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-29T17:35:16.267Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"is_link":false,"parentDoc":null,"project":"542998547a6b69080076806e","user":"542998207a6b690800768069","version":{"__v":9,"_id":"542998547a6b690800768071","project":"542998547a6b69080076806e","createdAt":"2014-09-29T17:35:16.249Z","releaseDate":"2014-09-29T17:35:16.249Z","categories":["542998547a6b690800768072","5433027990d63b1c0030c0f1","5433028190d63b1c0030c0f2","5433028d9a2b451a00ad4508","5433055790d63b1c0030c10a","5461417d37e5bc200049e1e4","54624066ddd31b0800a58db4","54625de66d1f1010002f3901","54d309955616470d0013cc55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["5446b92aae0040140035fa08","5511db4e0c1a08190077f891","5744c13219b06d0e006a4d6d"],"next":{"pages":[],"description":""},"createdAt":"2014-10-07T00:14:50.826Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"settings":"","try":true,"auth":"never","params":[],"url":""},"isReference":false,"order":7,"body":"In [Getting Started - Web](doc:getting-started) we show the basics of where to find your integration code in our [Dashboard](https://pub.superrewards.com/login) and how to show our widget to your users.  Here is a full list of the options and fields that you can use to tweak the function and appearance of that payment and offer wall.\n\nThese fields are for passing to the endpoint \n`https://wall.superrewards.com/super/offers?...`\n\n* [Required Fields](#required)\n* [Optional Fields](#optional)\n* [Custom Fields](#custom)\n[block:html]\n{\n  \"html\": \"<a name='required'></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Fields\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example value\",\n    \"0-0\": \"`h`\",\n    \"1-0\": \"`uid`\",\n    \"0-1\": \"App hash, the unique hash value for every app, which you can find in the App Settings in the [Dashboard](https://pub.superrewards.com/).\",\n    \"0-2\": \"`nhhpuxlrfgi.022815956433`\",\n    \"1-1\": \"a unique ID for the user, either numeric or text. Check out our [Notes On UIDs](TODO), and please [URI-encode](http://www.w3schools.com/tags/ref_urlencode.asp) any unusual characters\",\n    \"1-2\": \"* `987123456`\\n* `steve48`\\n* `testuser%40gmail.com`\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name='optional'></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Optional Fields\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example value\",\n    \"0-0\": \"`hoffers`\",\n    \"0-1\": \"When set to 1, hides the offer list portion of the wall, showing only the payments portion.\",\n    \"0-2\": \"`1`\",\n    \"1-0\": \"`hdpay`\",\n    \"1-1\": \"When set to 1, hides the payments portion of the wall, showing only the offer list.\",\n    \"1-2\": \"`1`\",\n    \"2-0\": \"`gender`\",\n    \"2-2\": \"* `male`\\n* `female`\",\n    \"2-1\": \"The gender of the user, to help us target offers to them better.\",\n    \"3-0\": \"`age`\",\n    \"3-1\": \"The age, in years, of the user, to help us target offers to them better.\",\n    \"3-2\": \"`28`\",\n    \"4-0\": \"`xml` or `json`\",\n    \"4-1\": \"When set to `1`, these fields will return an XML or JSON-encoded list of payment mthods and offers, so that you can show them to the user in your own app UX.\",\n    \"4-2\": \"\",\n    \"5-0\": \"`default_tab`\",\n    \"5-1\": \"Forces the default (initially selected) tab on your wall to one of these options, pass the number for the tab you want selected.\",\n    \"6-0\": \"`only_tab`\",\n    \"6-1\": \"Similar to `default_tab`, but hides ALL tabs other than the one you pass in as a number.\",\n    \"6-2\": \"1. popular\\n2. free\\n3. paid\\n4. survey\\n5. video\\n6. tasks\",\n    \"7-0\": \"`payout_min`\",\n    \"7-1\": \"Define a minimum payout for offers displayed on the offer wall. To use this parameter, you must also include the `min_srt` parameter, and you must enable Payout Adjustment on the app, from your publisher dashboard.\",\n    \"7-2\": \"`1`\",\n    \"5-2\": \"1. popular\\n2. free\\n3. paid\\n4. survey\\n5. video\\n6. tasks\",\n    \"8-0\": \"`min_srt`\",\n    \"8-1\": \"The security parameter necessary to enable minimum payouts using `payout_min`. This paramter is an md5 hash of the `payout_min` value and your app's secret key.\\nex: `md5(<payout_min>.<secret key>)`\",\n    \"9-0\": \"`payout_max`\",\n    \"9-1\": \"Define a maximum payout for offers displayed on the offer wall. To use this parameter, you must also include the `max_srt` parameter, and you must enable Payout Adjustment on your app, from your publisher dashboard.\",\n    \"9-2\": \"`20`\",\n    \"10-0\": \"`max_srt`\",\n    \"10-1\": \"The security parameter necessary to enable maximum payouts using `payout_max`. This parameter is an md5 hash of the `payout_max` value and your app's secret key.\\nex: `md5(<payout_max>.<secret_key)`\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Other Parameters - Enabled by your account manager:\",\n  \"body\": \"Email your account manager (or Support) to have these parameters added to your postback:\\n * User IP Address:  `client_ip`\\n * App ID:  `app_id`\\n * Country Code:  `client_country_code`\\n * Payout:  `client_payout`\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name='custom'></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Custom Fields\"\n}\n[/block]\nIf you would like to receive custom parameters in your [Notification Postbacks](doc:notification-postbacks), you can specify them in the query string here.\n\nAny fields that you pass us that start with `custom_` will be passed back to your system.","excerpt":"","slug":"postback-parameters","type":"basic","title":"Postback Parameters"}

Postback Parameters


In [Getting Started - Web](doc:getting-started) we show the basics of where to find your integration code in our [Dashboard](https://pub.superrewards.com/login) and how to show our widget to your users. Here is a full list of the options and fields that you can use to tweak the function and appearance of that payment and offer wall. These fields are for passing to the endpoint `https://wall.superrewards.com/super/offers?...` * [Required Fields](#required) * [Optional Fields](#optional) * [Custom Fields](#custom) [block:html] { "html": "<a name='required'></a>" } [/block] [block:api-header] { "type": "basic", "title": "Required Fields" } [/block] [block:parameters] { "data": { "h-0": "Field name", "h-1": "Description", "h-2": "Example value", "0-0": "`h`", "1-0": "`uid`", "0-1": "App hash, the unique hash value for every app, which you can find in the App Settings in the [Dashboard](https://pub.superrewards.com/).", "0-2": "`nhhpuxlrfgi.022815956433`", "1-1": "a unique ID for the user, either numeric or text. Check out our [Notes On UIDs](TODO), and please [URI-encode](http://www.w3schools.com/tags/ref_urlencode.asp) any unusual characters", "1-2": "* `987123456`\n* `steve48`\n* `testuser%40gmail.com`" }, "cols": 3, "rows": 2 } [/block] [block:html] { "html": "<a name='optional'></a>" } [/block] [block:api-header] { "type": "basic", "title": "Optional Fields" } [/block] [block:parameters] { "data": { "h-0": "Field name", "h-1": "Description", "h-2": "Example value", "0-0": "`hoffers`", "0-1": "When set to 1, hides the offer list portion of the wall, showing only the payments portion.", "0-2": "`1`", "1-0": "`hdpay`", "1-1": "When set to 1, hides the payments portion of the wall, showing only the offer list.", "1-2": "`1`", "2-0": "`gender`", "2-2": "* `male`\n* `female`", "2-1": "The gender of the user, to help us target offers to them better.", "3-0": "`age`", "3-1": "The age, in years, of the user, to help us target offers to them better.", "3-2": "`28`", "4-0": "`xml` or `json`", "4-1": "When set to `1`, these fields will return an XML or JSON-encoded list of payment mthods and offers, so that you can show them to the user in your own app UX.", "4-2": "", "5-0": "`default_tab`", "5-1": "Forces the default (initially selected) tab on your wall to one of these options, pass the number for the tab you want selected.", "6-0": "`only_tab`", "6-1": "Similar to `default_tab`, but hides ALL tabs other than the one you pass in as a number.", "6-2": "1. popular\n2. free\n3. paid\n4. survey\n5. video\n6. tasks", "7-0": "`payout_min`", "7-1": "Define a minimum payout for offers displayed on the offer wall. To use this parameter, you must also include the `min_srt` parameter, and you must enable Payout Adjustment on the app, from your publisher dashboard.", "7-2": "`1`", "5-2": "1. popular\n2. free\n3. paid\n4. survey\n5. video\n6. tasks", "8-0": "`min_srt`", "8-1": "The security parameter necessary to enable minimum payouts using `payout_min`. This paramter is an md5 hash of the `payout_min` value and your app's secret key.\nex: `md5(<payout_min>.<secret key>)`", "9-0": "`payout_max`", "9-1": "Define a maximum payout for offers displayed on the offer wall. To use this parameter, you must also include the `max_srt` parameter, and you must enable Payout Adjustment on your app, from your publisher dashboard.", "9-2": "`20`", "10-0": "`max_srt`", "10-1": "The security parameter necessary to enable maximum payouts using `payout_max`. This parameter is an md5 hash of the `payout_max` value and your app's secret key.\nex: `md5(<payout_max>.<secret_key)`" }, "cols": 3, "rows": 11 } [/block] [block:callout] { "type": "info", "title": "Other Parameters - Enabled by your account manager:", "body": "Email your account manager (or Support) to have these parameters added to your postback:\n * User IP Address: `client_ip`\n * App ID: `app_id`\n * Country Code: `client_country_code`\n * Payout: `client_payout`" } [/block] [block:html] { "html": "<a name='custom'></a>" } [/block] [block:api-header] { "type": "basic", "title": "Custom Fields" } [/block] If you would like to receive custom parameters in your [Notification Postbacks](doc:notification-postbacks), you can specify them in the query string here. Any fields that you pass us that start with `custom_` will be passed back to your system.