Android SDK

3.17.0 [2 Mar 2020]

  1. Adds support for Iran Proxy Environment

3.16.0 [26 Feb 2020]

  1. Adds support for new Google Play Install Referrer Library.

3.15.0 [27 Dec 2019]

  1. Adds support for Landscape Modal In-app Views

3.14.0 [6 Dec 2019]

  1. Clears all saved SDK data on license code change.

3.13.1 [21 Oct 2019]

  1. Fixes cropped custom collapsed push notification when target-sdk version is below 24.
  2. Prevents redundant user-update requests if user-profile is already up-to-date.
  3. Logs custom user attributes in logcat when debug-mode is enabled.

3.13.0 [24 Sep 2019]

  1. Adds WhatsApp channel.

3.12.6 [23 Sep 2019]

  1. Fixes in-app shown on incorrect screen by rechecking before rendering the in-app.

3.12.4 [19 Sep 2019]

  1. Fixes formula for calculating in-app variation and control-group for users.
  2. Adds support for in-app control-group in journeys.

3.12.3 [14 Aug 2019]

  1. Adds SDK version as query parameter in push amplification request URL.

3.12.2 [13 Aug 2019]

  1. Fixes push notifications being shown multiple times.
  2. Schedules push-amplification if not scheduled on SDK initialization.

3.12.1 [31 Jul 2019]

  1. Syncs background system events immediately with our server.
  2. Adds Device Registered (Push), App Installed and App Upgraded to high-priority events.

3.12.0 [13 Jul 2019]

  1. Adds push amplification.

3.11.1 [2 Jul 2019]

  1. Fallsback to AWS-US environment for any invalid value of region/environment.

3.11.0 [25 Jun 2019]

  1. Adds support for india environment.

3.10.8 [24 May 2019]

  1. Fixes bug which sent empty FCM push token, if not found on app update.

3.10.7 [22 Apr 2019]

  1. Updates CUID in local data-storage on user login for showing CUID based in-app notifications.
  2. Updates location of unknown users in local data-storage from user-profile for showing location based in-app notifications to unknown users.

3.10.4 [13 Feb 2019]

Fixes triggered in-app behavior by clearing session level data on every new session.

3.10.3 [Jan 30, 2019]

Fixes crash due to StackOverflowError while processing large lists on low-end devices.

3.10.2 [Jan 29, 2019]

  1. Optimizes in-app performance in journeys. Now in-app notifications will be shown within 15 seconds after user has entered the journey while app is in foreground.
  2. New session is created on every app launch after force kill, irrespective of time interval between kill and launch.
  3. Fixes issue of online session not being destroyed which caused incorrect online session time span on Xiaomi devices due to cancellation of alarms on force killing the app.
  4. Logs event and user attributes along with event name in debug mode.

3.10.1 [Jan 4, 2019]

Adds callbacks to render custom push notification layouts

3.9.7 [Dec 10, 2018]

Fixes a bug on devices running Oxygen OS which prevented app being launched through push notification click after the app was killed or in other words, cleared/removed the app from background.

3.9.5 [Nov 15, 2018]

Fixes a bug that generated new interface ID on app update.

3.9.1 [Oct 15, 2018]

Adds support for multi-process apps. Apps can track users, events, screens, etc. through Android components running on different processes.

3.8.1 [Oct 3, 2018]

Fixes build error in Gradle versions 3.3 and below.

3.8.0 [Oct 1, 2018]

Adds custom push notification layouts which will be shown if key-value pair (we_push_custom: true) is passed while creating the push campaign.

3.7.11 [Sep 25, 2018]

  1. Adds logs in debug mode, which are useful for debugging.
  2. Fixes crash when initializing WebEngage from a remote process while app is in background on Android Oreo and newer devices.
  3. Fixes crash when activity is in finishing state while showing in-app notification.

3.7.10 [Sep 17, 2018]

SDK is now compatible with Android P, Google Play Services SDK version 15.0.1 and Firebase Cloud Messaging SDK version 17.3.2.

3.7.9 [Sep 4, 2018]

Fixes the behaviour of removing push notification images from cache on config refresh while notifications were still in tray.

3.7.8 [Sep 4, 2018]

Fixes NegativeArraySizeException thrown while trying to delete empty list of cached files.

3.7.7 [Aug 31, 2018]

Allows dismissing carousel push notifications on image click by adding custom key-value pair (we_dismiss: true) on dashboard while creating carousel push notifications.

3.7.6 [Aug 29, 2018]

Fixes incomplete in-app notifications shown in some devices due to custom activity configurations.

3.7.5 [Aug 27, 2018]

Fixes incomplete images shown in push notifications.

3.7.4 [Aug 16, 2018]

  1. Fixes WebEngage event sequencing issue on device network fluctuation.
  2. Fixes SDK intialization failure when user-defined channel group name is provided on devices below Android Oreo.
  3. Fixes forever unsynced WebEngage events when event syncing service is killed/interrupted unexpectedly.

3.7.3 [Jul 5, 2018]

Fixes a bug which incorrectly added users to in-app and push message control group in some cases.

3.7.2 [Jul 4, 2018]

Refactors internal SDK structure.

3.7.1 [Jun 7, 2018]

  1. Adds support for adaptive app icons in notifications on Oreo devices.
  2. Fixes the issue of some images not showing up in notifications. This also adds support for corrupt images (images with some missing data which are correctly shown on browsers but do not load in apps) in notifications.

3.7.0 [May 18, 2018]

  1. Automates SDK feature version increment which is reflected in user profiles.
  2. Logs invalid data types while sending user or event data, and converts them to String before sending.

3.6.1 [May 15, 2018]

  1. Optimizes in-app message performance.
  2. Reduces number of concurrent network requests on new user session.
  3. Removes unnecessary network requests.

3.6.0 [May 8, 2018]

  1. Adds options to configure automatic location tracking accuracy.
  2. Adds manual location tracking API.
  3. Replaces Integer, Float and Double to Number in set user attribute API.

3.5.1 [Release: April 9, 2018]

Fixes error while adding more than 5 geofences. You can now add upto 100 geofences.

3.5.0 [Release: April 5, 2018]

Supports all Number data types for user and event attributes.

3.4.2 [Release: April 4, 2018]

  1. Fixes crashes in Strict mode.
  2. Caches HTTP responses as files in data directory instead of a Blob in SQLite. This also fixes cursor window allocation warning.

3.4.0 [Release: March 19, 2018]

Optimizes background execution for apps targeting Android Oreo

3.3.0 [Release: February 5, 2018]

  1. Optimizes event reporting
  2. Event tracking APIs now take parameters to define the event priority

3.2.1 [Release: January 16, 2018]

  1. Adds a state change callback - Anonymous ID changed - which is invoked when anonymous ID of the user changes
  2. Optimizes event payload size

3.1.1 [Release: December 15, 2017]

Fixes bug where Notification Close event got fired in case of exception from WebView.

3.0 [Release: November 13, 2017]

Please go through our migration guide to upgrade to v3.0 of the Android SDK.

2.7 [Release: September 28, 2017]

New Feature

  1. Android Oreo compatible SDK. If you are targeting your application to Android Oreo (API level 26) then this is the minimum version of WebEngage SDK that should be present in your application, else push notifications will not be displayed.
  2. Implements default push notification channel which will display push notifications. For customising default channel behaviour and appearance visit our [push notification channels section

2.4 [Release: May 10, 2017]

New Feature

Added capability to opt-out/in user from SMS and EMAIL channels. For more info visit user section.

2.3 [Release: April 15, 2017]

New Feature

Added support for new push notification rating layout.

2.0 [Release: February 28, 2017]

Please go through our migration guide

1.14 [Release: February 21, 2017]

New Feature

1.Added support for conversion tracking in in-app notifications.


1.Deprecated user loggedIn and loggedOut apis . Two new apis login and logout has been provided and should be used instead.

2.Deprecated setSound, setVibrateFlag and setPriority apis.

1.13 [Release: November 29, 2016]

New Feature

  1. Now tracking whether or not a user has opted out of push notifications from his device for an app.(This will work only if support dependency 24+ is added and api level of device is 19+).

1.12 [Release: November 23, 2016]

New Feature

  1. Added support for new push notification carousel layout.(Android support library version 24.+ is required)

1.11 [Release: November 4, 2016]

New Feature

  1. Added setter apis for providing hashed email and hashed phone number of user.Please refer user docs for more information.

1.10 [Released: September 20, 2016]

New Feature

  1. Added support for 3 InApp layouts(Header, Footer and Classic modal).
  2. Added support of Geofencing.


  1. WebEngage SDK now truncates certain inputs beyond below mentioned limits
    • Event name - 50 chars
    • Event attribute key - 50 chars
    • Event attribute value (String) - 1000 chars
    • CUID(User Identifier) - 100 chars

1.9.8 [Released: August 2, 2016]


  1. WebEngage SDK no longer holds a weak reference to your callback implementations.

1.9 [Released: June 19, 2016]

New Features

  1. Added support for nested attributes that can be only used in personalisation.

1.8 [Released: June 13, 2016]

New Features

  1. Added support for personalisation through templates.


  1. WebEngage no longer automatically scans for push, in-app or lifecycle callback implementations. Now you need to manually register your implementations.Please go through migration guide

1.7 [Released: June 8, 2016]

New Features

  1. Added support for in-app campaign in journey.

1.6.4 [Released: May 18, 2016]

New Features

  1. Added ability to change small and large icon of push notification from onPushNotificationReceived callback.
  2. Added ability to change the accent color of push notification.

1.6.1 [Released: May 17, 2016]

Bug fixes

  1. Fixed parcelable unmarshalling bug which was occurring in some devices.

1.6 [Released: May 12 , 2016]

New Features

  1. Added ability to personalize in-app messages.

Bug fixes

  1. Fixed build failed issue caused by older gradle versions.

1.5 [Released: May 5 , 2016]

New Features

  1. Added ability to segment users based on the time occurrence of events(both system and application).

1.4 [Released: April 28 , 2016]

New Features

  1. Added ability to target users that have date type attributes which fall under a sliding time window.
    eg: Send push notification to users whose ticket booked date is within next 7 days.

1.3 [Released: April 23 , 2016]

New Features

  1. Added ability to segment users based on system events and attributes i.e now you can segment users based on their interaction with our engagement products.
  2. Added ability to override default click behaviour of push and in-app notifications.

1.2.1 [Released: April 14 , 2016]

New Features

  1. Handled Runtime Location Permission in Marshmallow .
  2. Added custom deep link support .
  3. Handling of SDK version for backward compatibility .
  4. Added "setAction()" method in "CallToAction" class that allows to override the deep link or external url received for a particular push or in-app .
  5. Handling of Doze mode in Marshmallow .
  6. Added setEveryActivityIsScreen() method to "WebEngage" class.


  1. All callbacks implementation must reside in main package of application.
  2. Renamed "ActionButton" class to "CallToAction" .
  3. Removed default exception catching from "onPushNotificationReceived" and "onInAppNotificationPrepared" methods.
  4. Added check for prefix "we_" in custom event name.

Bug fixes

  1. Fixed issue caused by invalid CTA .
  2. Fixed custom event attribute bug.

Updated 23 days ago

Android SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.