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

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

Introduction

Events refers to the actions your users perform on your app or website eg. purchase, add to wishlist, search etc. Events also includes other actions such as app install, app uninstall, email open, email click etc. Each such event has attributes attached to it that captures where and when the event happened (eg. event time, location, device) and also describes the event in detail (eg. for Purchase event - item category, item price etc.). You can use event-related information to understand your users better, segment them and personalize your campaigns.

Before you start the integration process, please ensure that you are consistent with the usage of event names and the attributes attached to each, across all platforms such as, Android, iOS and Website. We recommend that you create an excel sheet where you can list down all the events you want to track along with their corresponding attributes and data-types. Data-types, once defined, cannot be changed later. If WebEngage receives data in a different datatype from what was first defined, it will not be able to record this data.

Types of Events

Events on WebEngage are of 3 types: System, Custom and Campaign.

System Events

These events (except User Login, User Logout) are automatically captured by WebEngage as soon as the SDK integration is done. Here's a complete list of all the system events defined by WebEngage:

Event name
Description

App Installed

When the app gets installed

App Upgraded

When the app is upgraded

App Crashed

When the app crashes

App Uninstalled

When app is uninstalled

User Login

Whenever you call the login function on user login, signup etc.

User Logout

Whenever you call the logout function

New Session Created

Whenever a new session is created

Custom Events

These event are sent by you to WebEngage, based on the actions performed by your users, on your mobile app and/or website. Some examples of these events are: Purchased, Category Viewed, Searched etc. You will be able to define events according to the needs and nature of your business.

We recommend that you track the following events based on the industry that your business is in: E-commerce, Travel, Game apps, BFSI.

Campaign Events

These events are automatically captured by WebEngage, based on the actions your users perform on the campaigns they receive through WebEngage. Here's a list of all the campaign events available on WebEngage.

Event name
Description

Campaign Conversion

When a user completes the conversion event attached to a campaign

GCM/APNs Registered

When a device is successfully able to register for push notifications

APNs Registration Failed

When device fails to register for push notifications

Push (Mobile) Sent

When mobile push notification is sent

Push (Web & Mobile) Accepted

When a mobile push or web push campaign is forwarded by WebEngage for delivery by GCM

Push (Web & Mobile) Rejected

When a mobile push or web push campaign is rejected by WebEngage and is not forwarded to GCM

Push (Mobile) Received

When a device successfully receives a mobile push notification

Push (Web & Mobile) Dismiss

When a user dismisses a mobile push or web push notification

Push (Web & Mobile) Impression

When a user views a mobile push or web push notification

Push (Web & Mobile) Click

When a user clicks a mobile push or web push notification

Push (Mobile) Rating Submitted

When a user submits a rating for a mobile push notification ratings campaign

Push (Mobile) Carousel Item Viewed

When a user views items in a mobile rich push notification

Push (Web) Registered

When a user has successfully subscribed to web push after clicking “Allow” on native prompt

Push (Web) Unregistered

When a user was unsuccessful in subscribing to web push after clicking “Allow” on native prompt

Notification (On-site & In-app) Impression

When a user views an on-site notification or in-app notification

Notification (On-site & In-app) Close

When a user closes an on-site notification or in-app notification

Notification (On-site & In-app) Click

When a user clicks on an on-site notification or in-app notification

On-site Feedback View

When a user views an on-site feedback

On-site Feedback Close

When a user closes an on-site feedback

On-site Feedback Submit

When a user submits an on-site feedback

On-site Survey View

When a user views an on-site survey

On-site Survey Close

When a user closes an on-site survey

On-site Survey Complete

When a user completes an on-site survey

On-site Survey Submit

When a user submits an on-site survey

SMS Sent

When a SMS is sent

SMS Accepted

When a SMS campaign is forwarded by WebEngage for delivery by SSP

SMS Rejected

When a SMS campaign is rejected by WebEngage and is not forwarded to SSP

SMS Failed

When a SMS fails to deliver as reported by the SSP

SMS Click

When a user clicks on a link in a SMS

Email Sent

When an email is sent

Email Accepted

When a email campaign is forwarded by WebEngage for delivery by ESP

Email Rejected

When a email campaign is rejected by WebEngage and is not forwarded to ESP

Email Bounced

When an email gets bounced as reported by the ESP

Email Delivered

When an email is delivered as reported by the ESP

Email Complaint

When a user or an email client like Gmail complains about the email (in case of phishing etc.)

Email Abuse Report

When a user marks an email as Spam

Email Resubscribe

When a user subscribes again to receive email campaigns

Email Unsubscribe

When a user unsubscribes from all email campaigns

Email Spam Report

When a user marks an email as Spam

Email Open

When a user opens an email

Email Click

When a user clicks on a link in an email

Web Push Subscribe Viewed

When a user views the native browser web push subscribe prompt

Web Push Subscribe Denied

When a user clicks “Block” on the native browser web push subscribe prompt

Web Push Subscribe Successful

When a user clicks “Allow” on the native browser web push subscribe prompt

Web Push Subscribe Notification Viewed

When a user views the on-site prompt to subscribe to web push

Web Push Subscribe Notification Denied

When a user clicks “Deny” on the on-site prompt to subscribe to web push

Web Push Subscribe Notification Allowed

When a user clicks “Allow” on the on-site prompt to subscribe to web push

Event Attributes

All events have attributes attached to them that capture its details. Eg. Attributes of a purchase event would include the time of event, device on which the event happened, location from where the event happened, details of the item purchased etc.
Attributes are of 2 types: System and Custom. These attributes are applicable to different event types, as follows:

  • System Events: Only have system attributes
  • Custom Events: Have both system and custom attributes
  • Campaign Events: Only have system attributes

System Attributes

These are defined by WebEngage and are automatically captured as and when an event happens. You cannot overwrite these values or modify them in any way.

Here’s a complete list of system attributes defined by WebEngage:

Name
Type
Description

Event Time

DateTime

Time when the event occurred in ISO Format

Country

String

Country where the event occurred

City

String

City where the event occurred

Browser Name

String

Name of the browser on which the event occurred

OS Name

String

Name of the OS on which the event occurred

Device Manufacturer

String

Name of the manufacturer of the device on which the event occurred

Device Model

String

Device model on which the event occurred

Carrier

String

The device cellular network on which the event occurred

App Version

String

The version of the app on which the event occurred

App ID

String

The ID of the app on which the event occurred

Platform

String

The platform on which the event occurred - one of Android, iOS, Website

Channel

String

The channel (Direct, Organic Search, Social etc.) that resulted in the occurrence of the event

Campaign Source

String

The UTM source of the marketing campaign that resulted in the occurrence of the event

Campaign Medium

String

The UTM medium of the marketing campaign that resulted in the occurrence of the event

Campaign Name

String

The UTM name of the marketing campaign that resulted in the occurrence of the event

Page URL

String

The page URL on which the event occurred (in case of website)

Screen Name

String

The screen name on which the event occurred (in case of mobile app)

Campaign ID

String

The ID of a campaign that was sent through WebEngage

Variation ID

String

The ID of the variation in a campaign that was sent through WebEngage

Journey ID

String

The ID of the journey in WebEngage that the campaign is a part of

Custom Attributes

You can define custom attributes of an event depending on your business needs. For example, a Purchase event could have the following attributes: Item Name, Item Price, Currency, Category Name, Category Code.

We recommend the following custom events and event attributes based on the industry that your business is in: E-commerce, Travel, Game apps, BFSI.

Please also take note of the following limitations of custom attributes:

  • You can use strings, numbers, arrays, maps and booleans to define your attributes
  • An event can have a maximum of 25 attributes, per data-type
  • Maximum length of an attribute name and and an event name is 50 characters
  • Maximum length of an attribute value of String data-type is 1000 characters
  • Custom attributes must not have names starting with we_

Tracking Events

System and campaign events are tracked automatically by WebEngage. You can send Custom events to WebEngage by calling the respective SDK functions - Website, Android, iOS

Events