WebEngage is a multi-channel marketing automation tool that helps you focus on your product by it taking all the headache of marketing related changes.

We provide SDKs that integrate with your website, Android or iOS application. These SDKs expose APIs to track events and build user profiles. There are other APIs and a callback interface to customize look and behavior of individual engagements such as notifications, survey and feedback widget beyond what is provided on our dashboard.

Please see our SDK change log.

Getting Started

Once you have signed up, create an account and configure each of the platforms you intend to use WebEngage on from the Integrations screen.

Integrating SDKs

WebEngage provides SDKs for following platforms -

  • For your websites (Desktop, Mobile and Tablet) - Web SDK
  • For your Android app (Mobile and Tablet) - Android SDK
  • For your iOS app (Mobile and Tablet) - iOS SDK

On WebEngage dashboard, from the Manage Accounts screen copy the license code (seen highlighted in the image below) and configure it in the integrated WebEngage SDK.

Make sure you configure the same license code for WebEngage SDK integrations across different platforms (website, apps).

Feel free to create a new testing account in WebEngage dashboard for your Dev/Test/QA environment. Drop an email to support@webengage.com, just so that we can mark this account as test account and our system stops waiting for any money to come in.

Data Model

The data model that an SDK exposes -

User Profiles

For each user of your website, Android or iOS application - whether anonymous or known WebEngage creates and maintains a user profile. You can set known user information on these profiles in the form of simple attributes. Once a user logs in or when their identity is known you can assign a User ID to the profile. This will gather that same user's activity across devices / browsers in a single unified profile.

See User Profiles for details.

Identify a user and set attributes via Web SDK | Android SDK | iOS SDK | REST API

Event Tracking

Any user activity on your website or within your mobile application that you want to track should be passed as an event to WebEngage.

See Events for details.

Track an event via Web SDK | Android SDK | iOS SDK | REST API

Screen Data

Any contextual information on the current web page / application screen such as screen name, title, URL, Product ID on a product page etc. can be passed to WebEngage. This data is not saved by WebEngage except on notification clicks and survey and feedback submissions. This data can be used for additional page level targeting and personalization.

Pass screen data in Web SDK | Android SDK | iOS SDK

Engagement APIs

Notification

APIs and callbacks for on-site / in-app notification displayed on web page / application screen.

Web SDK | Android SDK | iOS SDK

Survey

APIs and callbacks for on-site survey displayed on web page.

Web SDK

Push Notification

Callbacks for push notifications pushed to your mobile app.

Android SDK | iOS SDK

Feedback

APIs and callbacks for on-site feedback displayed on your website

Web SDK

REST APIs and WebHooks

WebEngage provides REST APIs to receive events and create or update user profiles. There are APIs to query engagement stats and reports.

We also provide webhooks for some engagement events such as feedback and survey submissions and an event webhook that triggers on receiving an event in the system.

See REST APIs and WebHooks for details.

Overview