Set up WebEngage
WebEngage is an analytics partner integrated with Adjust. Our integration lets WebEngage receive data measured in Adjust through automated callbacks. Use this data with the partners' tools for analytics and insights.
In this article, learn how to set up measurement with WebEngage for your app. This includes activating the integration and choosing what data Adjust can share with WebEngage.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to WebEngage parameters. Follow the guides linked below to use this feature.
iOS | Android | Windows | Unity | React Native | Flutter | Adobe Air | Cordova | Marmalade | Xamarin | Cocos2d-x | Titanium | Corona
Credentials
API KEY
- For help finding your credentials, contact your WebEngage representative.
Select WebEngage and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > WebEngage. Select Next to move to the next screen.
- In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with WebEngage.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with WebEngage. To enable data sharing:
- Enter your API KEY.
Once you enable data sharing with WebEngage, Adjust automatically sends WebEngage the following data, by default:
- install
Set your data sharing options
If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:
- Separate data sharing options at the platform-level by selecting Use platform-specific settings.
- Set the same data sharing settings for multiple platforms by selecting Use global settings.
Now, under What will be shared by default?, review the activities that Adjust shares with WebEngage by default:
- install
Send additional data
Choose the amount and type of data that you want to share with WebEngage through callbacks. WebEngage may use this information to optimize performance.
To send additional data, you can review and customize the following:
Enable WebEngage for your app
In the Setup review screen, you can review your choices. You can also go back and make changes to:
- Your selected app
- Data sharing options
Select Enable partner to enable WebEngage for your app. Analytics partners don't work with links for campaigns. Once enabled, our integration sends attribution and in-app event data via automated callbacks.
List of all parameters forwarded to WebEngage
WebEngage requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{android_id} | Android ID (Android only) |
{country} | Device two-character country code |
{device_name} | Device model number |
{gps_adid} | Google Play Store advertising ID |
{idfa_upper} | Uppercase IDFA |
{idfv} | Uppercase iOS ID for vendors |
{ip_address} | Device IP address |
{language} | Device two-character language code |
{os_version} | Operating system version number |
{user_agent} | Incoming raw user agent |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{app_version_raw} | App version number (Android), build-version-number for the bundle (iOS) |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{campaign_name} | Campaign name, as taken from the tracker |
{click_time} | Attributed click timestamp |
{installed_at} | Install (i.e., first app open) timestamp |