English한국어
English

What is Event

Suggest Edits

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");
Sample events in Channel Desk

Sample events in Channel Desk

Limitations

Event property payloads containing arrays or object values are limited to a maximum size of 4KB.


Supported Property Types

String

  • Represents alphanumeric values. Examples: Plan Type = "Free", Artist Name = "Bruno Mars".
  • Maximum length: 512 bytes per string property.
  • Character encoding affects the number of bytes required per character.
  • Any property value not matching other defined data types is treated as a String.

Numeric

  • Represents numeric values (integer or decimal). Examples: Cost = 15.00, Quantity = 5.

Boolean

  • Represents true or false values, explicitly using JSON constants true or false. Examples: Favorite = true, Bookmarked = false.
  • Non-boolean values cannot be typecast to boolean.

Date / DateTime

  • Date: Represents a calendar date without time (YYYY-MM-DD). Accepted formats include:
    • ISO date string (e.g., "2025-06-17")
    • Unix timestamp in milliseconds (time component ignored)
    • Instant object representing a date-only value
  • DateTime: Represents a specific instant including date, time, and timezone. Values are normalized to UTC for comparisons. Accepted formats include:
    • ISO date/time string (e.g., "2025-06-17T14:30:00Z")
    • Unix timestamp in milliseconds

List (Array)

  • JSON array containing strings or numeric values. Examples:
    • Favorite Genres = ["Folk", "Alternative"]
    • Favorite Numbers = [1, 5, 10.0]
  • Only String and Numeric types are supported.

List of Objects

  • JSON array consisting of one-level nested JSON objects with uniform key-value structures. Example:
    • Cart = [{"Brand":"Puma","Category":"Jacket","Price":30}, {"Brand":"Adidas","Category":"Hats","Price":15}]
  • Only the first 5 objects in a list are supported.
  • Limited to a single nesting level.

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.

Reference

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

Updated 13 days ago