Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results

Getting started

1. Install WebEngage plugin

Use the below command to install WebEngage plugin for both Android and iOS platforms.

cordova plugin add cordova-plugin-webengage --fetch

Follow the below steps for iOS platform:

  1. Download the SDK file here. Extract the downloaded ZIP file. You will find two directories in the extracted ZIP: xc7 and xc8. If you are using Xcode 7 use the Webengage.framework within the xc7 directory. For Xcode 8 and above use the one in xc8.
  2. Select the name of the project in the project navigator. The project editor appears in the Editor area of the Xcode workspace window.
  3. Click on the General tab at the top of project editor.
  4. In the section Embedded Binaries click on the "+" button to open the file chooser for your project. Open WebEngage.framework and select Copy if needed option. This will copy the framework to your project directory.
  5. Under Linked Frameworks and Libraries click the "+" button and add SystemConfiguration.framework and CoreLocation.framework.
  1. In the 'Build Settings' tab of the project editor, search for Other Linker Flags option. Add -lsqlite3 and -ObjC under it as shown below.
  1. Enable Push Notifications
    a. Enter Project Navigator view.
    b. Select your main app target from the expanded sidebar or from the dropdown menu, then select the Capabilities tab.
    c. If Push Notifications isn't enabled, click the switch to add the "Push Notifications" entitlement to your app. If you are using Xcode 8 or above, ensure that a YOUR-APP-NAME.entitlements file has been added to your project.

2. Integrate the SDK

Follow the below steps to integrate WebEngage SDK.

1. Add global configuration

Open we_config.xml file from the plugins\cordova-plugin-com-webengage directory inside your app's root directory. All global configurations go under the config tag.

a. licenseCode: Obtain your license code from the header title of the Account Setup section of your WebEngage dashboard and paste it within the licenseCode tag.
b. debug: This is optional. Debug logs from WebEngage SDK are printed if the value of this tag is true. Default value of this tag is false.


2. Add platform-specific configuration


Add all the Android-specific configuration under the android tag under the global config tag.
packageName: Add your complete Android application package name under packageName tag.



No mandatory configuration is required for iOS app. For advanced configuration, check the Other configurations section.

3. Initialize the plugin

In your onDeviceReady callback, call webengage.engage.

onDeviceReady: function() {

Additional WebEngage options and callbacks to be 
registered here before calling webengage.engage()


Next steps

Congratulations! You have now successfully integrated WebEngage with your Hybrid app and are now sending user session data to WebEngage.

Note that it may take a few minutes for your data to show up on the WebEngage dashboard. We suggest you meanwhile proceed to read the next sections to learn how to:

  1. Track user properties as attributes
  2. Track user actions as events
  3. Integrate push messaging
  4. Integrate in-app messaging

Getting started