Tracking events

Any action of interest done by a user is an event. For example, in case of an e-commerce app when a user adds an item to the shopping cart, the app would want to record the "Added to Cart" event along with the product details and price. Events may also be actions carried out by your system in the context of a user, say to track the user's inactivity or to notify departure of a shipment.

Each event has a name and an optional set of attributes describing the event in detail as necessary. An event attribute is a piece of data associated with an event. In the above example, product details and price are the “Added to Cart” event attributes. We recommend you make your events human readable - as an example, you can use a verb in the past tense like “Product Searched” and “Added to Cart”.

Event tracking lets you track user actions in your app, which enables you to create user segments and engagement campaigns based on this activity. We have put together a list of event templates for you to refer to.

Events accumulate over time, and WebEngage sends events in batches periodically to minimize network usage and maximize battery life.

System events

WebEngage starts tracking some events automatically as soon as you integrate the SDK. These are called System Events and they track your users’ interactions with your app and campaigns. Note that 2 system events are not tracked automatically - User Login and User Logout.

System events make it easier to analyze user behavior and optimize your marketing around common business goals such as driving user registrations or purchases. You can use custom events for any other user actions you want to track.

You can find the list of system events tracked by WebEngage here.

Please note that sdk_id attribute ('Platform' on WebEngage dashboard) of these events signifies the SDK. sdk_id is 1 for Web, 2 for Android and 3 for iOS.

Custom events

Custom events enable you to track user actions in your app. All Events related APIs are part of WebEngage iOS SDK's WEGAnalytics object. You get an instance of WebEngage WEGAnalytics object as follows.

import WebEngage
let weAnalytics: WEGAnalytics = WebEngage.sharedInstance().analytics
// import WebEngage ‘Analytics’
#import <WebEngage/WEGAnalytics.h>

// Get an instance of ‘Analytics’ object
id<WEGAnalytics> weAnalytics = [WebEngage sharedInstance].analytics;


  • Event names must be less than 50 characters long.
  • Event attributes can be of these data types: NSString, NSNumber, NSDate, NSArray. You can also add Boolean attributes since its wrapped type is NSNumber.
  • Event attribute names must be less than 50 characters long. NSString type attribute values must be less than 1000 characters long.
  • You cannot start your event or event attribute names with we_.
  • You can create at most 25 event attributes of each data type across all instances of an event.
  • If attribute value is NSArray or NSDictionary, it cannot be used to create user segments. It can only be used to personalize campaigns.

After WebEngage has been successfully initialized, you can track an event as follows.

weAnalytics.trackEvent(withName: "Product - Page Viewed")
[weAnalytics trackEventWithName:@"Product - Page Viewed"];

If you want to add attributes to the event you are tracking, you can use NSDictionary to specify them and then attach to the event as follows.

let addedToCartAttributes: [String:Any]  = [
	"Product ID": 1337, 
	"Price": 39.80, 
	"Quantity": 1, 
	"Product": "Givenchy Pour Homme Cologne", 
	"Category": "Fragrance", 
	"Currency": "USD",
	"Is Premium": true
weAnalytics.trackEvent(withName: "Added to Cart", andValue: addedToCartAttributes)

var comps = DateComponents() = 6
comps.month = 10
comps.year = 2017
let deliveryDate: Date = comps)!
let orderPlacedAttributes : [String:Any] = [
	"Amount": 808.48, 
  "Product 1 SKU Code": "UHUH799", 
  "Product 1 Name": "Armani Jeans", 
  "Product 1 Price": 300.49, 
  "Product 1 Size": "L", 
  "Product 2 SKU Code": "FBHG746", 
  "Product 2 Name": "Hugo Boss Jacket", 
  "Product 2 Price": 507.99, 
  "Product 2 Size": "L", 
  "Delivery Date": deliveryDate, 
  "Delivery City": "San Francisco", 
  "Delivery ZIP": "94121", 
  "Coupon Applied": "BOGO17"
weAnalytics.trackEvent(withName: "Order Placed", andValue: orderPlacedAttributes)
NSDictionary *addedToCartAttributes=@{
  @"Product ID":@1337,
  @"Product":@"Givenchy Pour Homme Cologne",
  @"Is Premium":@YES
[weAnalytics trackEventWithName:@"Added to Cart" andValue:addedToCartAttributes];

NSDateComponents *comps = [[NSDateComponents alloc] init];
        [comps setDay:6];
        [comps setMonth:10];
        [comps setYear:2017];
        NSDate *deliveryDate = [[NSCalendar currentCalendar] dateFromComponents:comps];

NSDictionary *orderPlacedAttributes = @{
  @"Product 1 SKU Code":@"UHUH799",
  @"Product 1 Name":@"Armani Jeans",
  @"Product 1 Price":@300.49,
  @"Product 1 Size":@"L",
  @"Product 2 SKU Code":@"FBHG746",
  @"Product 2 Name":@"Hugo Boss Jacket",
  @"Product 2 Price":@507.99,
  @"Product 2 Size":@"L",
  @"Delivery Date":deliveryDate,
  @"Delivery City":@"San Francisco",
  @"Delivery ZIP":@"94121",
  @"Coupon Applied":@"BOGO17"
[weAnalytics trackEventWithName:@"Order Placed" andValue:orderPlacedAttributes];

1. Event names are case sensitive.
2. eventName must not start with we_. Event names starting with we_ are reserved for WebEngage's internal use, and will be ignored if used for custom events.
3. For custom events, the first datapoint synced to WebEngage defines the data type for that event attribute in WebEngage. Therefore, data types must be consistent with the data that you want to store for the attribute. If you change the data type later, attribute data will stop flowing to WebEngage.

Complex event attributes

WebEngage allows you to pass complex event attributes as NSArray and NSDictionary data types. You will be able to use these complex attributes to personalize campaigns as shown below.

Note that you will not be able to use complex attributes as segment filters, as you can see in the segment creation screen below.

You can pass complex event attributes as illustrated below.

let detailsProduct1 = ["Size": "L"]
let product1 : [String:Any] = ["SKU Code": "UHUH799", "Product Name": "Armani Jeans", "Price": 300.49, "Details": detailsProduct1]
let detailsProduct2 = ["Size": "L"]
let product2 : [String:Any] = ["SKU Code": "FBHG746", "Product Name": "Hugo Boss Jacket", "Price": 507.99, "Details": detailsProduct2]
let deliveryAddress = ["City": "San Francisco", "ZIP": "94121"]
var orderPlacedAttributes = ["Products": [product1, product2], "Delivery Address": deliveryAddress, "Coupons Applied": ["BOGO17"]]
weAnalytics.trackEvent(withName: "Order Placed", andValue: orderPlacedAttributes)
NSDictionary *detailsProduct1=@{

NSDictionary *product1=@{
  @"SKU Code":@"UHUH799",
  @"Product Name":@"Armani Jeans",

NSDictionary *detailsProduct2=@{

NSDictionary *product2=@{
  @"SKU Code":@"FBHG746",
  @"Product Name":@"Hugo Boss Jacket",

NSDictionary *deliveryAddress=@{
  @"City":@"San Francisco",

NSDictionary *orderPlacedAttributes=@{
  @"Products":@[product1, product2],
  @"Delivery Address":deliveryAddress,
  @"Coupons Applied":@[@"BOGO17"]

[weAnalytics trackEventWithName:@"Order Placed" andValue:orderPlacedAttributes];

What's Next

Push messaging

Tracking events

Suggested Edits are limited on API Reference Pages

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