What is Event

An event is an occurrence, especially one of significance, within your application or website. You can define any event that is specific to your business. If you are new to this concept, we recommend starting with a single metric event and a few other events that allow you to create a funnel.

The Event that default provide

The SDK provides the following events by default.

PageView : Occurs when a user visits a specific page.
UserChatOpen : Occurs when a user opens a new User chat.
MarketingView : Occurs when a user views a marketing message.
MarketingClick : Occurs when a user clicks on a link contained within a marketing message.
MarketingGoal : Events occur when a specific value is triggered, which is targeted in a marketing message.

What is a property

A property is additional information that describes an event. By analyzing this information, you can gain deeper insights and make informed decisions for your business.

A Property is a typically represented as a key-value pair dictionary, like as follows:

var properties = { 
  "userId": "1234", 
  "hasPurchaseA": true, 
  "lastVisitedAt": "2100-10-11"
}

let properties: [String: Any] = [
    "userId": "1234",
    "hasPurchaseA": true,
    "lastVisitedAt": "2100-10-11"
]

NSDictionary *properties = @{
    @"userId": @"1234",
    @"hasPurchaseA": @YES,
    @"lastVisitedAt": @"2100-10-11"
};

Map<String, Object> properties = new HashMap<>();
properties.put("userId", "1234");
properties.put("hasPurchaseA", true);
properties.put("lastVisitedAt", "2100-10-11");

Property types

The property can have values of the following types:

String
Numeric
Boolean
Date / DateTime
Lists
List of Objects
- It is parsed up to one depth, and any deeper levels will be replaced with a String.
- Parsing supports up to the first 5 objects only.
- Only String and Numeric types are supported.

The usage examples for each SDK are as follows:

Translation

The default events in the SDK and those received through the Builder integration offer translation support. Please refer to the page that outlines the Commerce integration events.

Shopify

Reference

To help you integrate our Event feature, we provide references for each platform: