> For the complete documentation index, see [llms.txt](https://docs.ayetstudios.com/v/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ayetstudios.com/v/product-docs/surveywall/web-integrations/web-surveywall.md).

# Web Surveywall

The Web Surveywall by ayeT-Studios allows you to easily monetize your desktop and mobile traffic with surveys that users can complete in exchange for getting a virtual currency reward.

## Eligible Placement & AdSlot Combinations <a href="#eligible-placement-and-adslot-combinations" id="eligible-placement-and-adslot-combinations"></a>

The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Web Surveywall integration.

| Placement Type | AdSlot Type    | Eligible Integration Type |
| -------------- | -------------- | ------------------------- |
| Website        | Web Surveywall | Web Surveywall            |

{% hint style="danger" %}
If you integrate the Web Surveywall while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the Surveywall.
{% endhint %}

## Utilization for Desktop, Mobile Web & In-App <a href="#utilization-for-desktop-mobile-web-and-in-app" id="utilization-for-desktop-mobile-web-and-in-app"></a>

Technically, the Surveywall has to be implemented by opening a new browser tab or loading the Surveywall link inside an iframe.

This type of Web Surveywall is intended to be called directly in an actual browser and is not very well suited for webview (in-app) integration.

For in-app integrations, please take a look at our seamless In-App integrations by checking out our available SDKs, Wrappers and Plugins.

{% hint style="info" %}
The **Web Surveywall** can nevertheless be used in-app if you follow a few guidelines

* Your placement has to be a "Website" placement
* You have to link out of your app to open the Web Surveywall in a mobile browser

Please follow the Integration Best Practises.
{% endhint %}

### Integration Best Practices <a href="#integration-best-practises" id="integration-best-practises"></a>

| Platform   | Integration Best Practise                                                                                        | Surveys                                                                                                                                                                                                       |
| ---------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Desktop    | Open the web surveywall in a new tab or iframe.                                                                  | The web surveywall shows surveys to the user.                                                                                                                                                                 |
| Mobile Web | Open the web surveywall in a new tab or iframe.                                                                  | The web surveywall adjusts its layout if users access via a mobile device. E.g. for accessing via an Android device, users will see a single column layout as oposed to a two-column layout like for desktop. |
| In-App     | Create a button in your app that leads users into their mobile browser and into the ayeT-Studios Web Surveywall. | The web surveywall shows eligible surveys to the user in a mobile optimized layout.                                                                                                                           |

## Getting Started

Before you start with the integration, make sure you:

* [x] Create an Account
* [x] Add a Placement
* [x] Add an AdSlot

You will find more details here:

{% content-ref url="/pages/W7CE6bNya8L7RoaXXY21" %}
[Dashboard Setup](https://docs.ayetstudios.com/v/product-docs/dashboard-setup.md)
{% endcontent-ref %}

## Your Web Survewall Link - Mandatory Parameters <a href="#your-browser-offerwall-link-mandatory-parameters" id="your-browser-offerwall-link-mandatory-parameters"></a>

The URL template for our web surveywall looks like this:

```
https://surveys.ayet.io/surveys?adSlot=ADSLOT_ID&external_identifier={YOUR_USER_IDENTIFIER}
```

To retrieve the URL for one of your web surveywall adslots, click on "Edit" next to an AdSlot under *Placements / Apps* and retrieve the *Integration URL* in the modal.

URL Parameters:

<table><thead><tr><th width="230">Parameter</th><th width="121.33333333333331">Mandatory</th><th>Description</th></tr></thead><tbody><tr><td>external_identifier</td><td>yes</td><td>Your identifier for the calling user - this is mandatory and allows you to attribute our Server2Server conversion callbacks to a specific user (returned in {uid})</td></tr><tr><td>custom_1</td><td>no</td><td><p>Custom parameter you can pass to the Surveywall Entry Link in the form of: &#x26;custom_1={YOUR_CUSTOM_PARAMETER}</p><p>You can get this variable back via conversion callbacks</p></td></tr><tr><td>custom_2</td><td>no</td><td><p>Custom parameter you can pass to the Surveywall Entry Link in the form of: &#x26;custom_2={YOUR_CUSTOM_PARAMETER}</p><p>You can get this variable back via conversion callbacks</p></td></tr><tr><td>custom_3</td><td>no</td><td><p>Custom parameter you can pass to the Surveywall Entry Link in the form of: &#x26;custom_3={YOUR_CUSTOM_PARAMETER}</p><p>You can get this variable back via conversion callbacks</p></td></tr><tr><td>custom_4</td><td>no</td><td><p>Custom parameter you can pass to the Surveywall Entry Link in the form of: &#x26;custom_4={YOUR_CUSTOM_PARAMETER}</p><p>You can get this variable back via conversion callbacks</p></td></tr><tr><td>custom_5</td><td>no</td><td><p>Custom parameter you can pass to the Surveywall Entry Link in the form of: &#x26;custom_5={YOUR_CUSTOM_PARAMETER}</p><p>You can get this variable back via conversion callbacks</p></td></tr></tbody></table>

## Conversion Callbacks & Currency Handling <a href="#conversion-callbacks-and-currency-handling" id="conversion-callbacks-and-currency-handling"></a>

Learn about:

* Setting up callbacks
* IP Whitelists
* Securing callbacks using HMAC Security Hash
* Testing callbacks

Click on the link below:

{% content-ref url="/pages/5sxVWIW1fto5Mmv1JxeJ" %}
[Callbacks & Testing](https://docs.ayetstudios.com/v/product-docs/callbacks-and-testing.md)
{% endcontent-ref %}
