Analytics Event Glossary

Widgets

Each widget analytics event has some common properties, found in the table below.

Property

Type

Description

Widget ID

String

Unique identifier of the widget

Widget Type

String

Kind of widget, e.g. "alert", "cheer-meter", "image-poll", etc.

Program ID

String

Unique identifier of the program the widget was received on

Widget Displayed

Fired when a user receives a widget.

🚧

This is a misnomer because the SDK doesn't have control over whether a widget is actually displayed to users, that is up to your application.

Widget Became Interactive

Fired when a widget is enabled for interaction.

Widget Interacted

Fired at every widget interaction. Includes a Number Of Taps property that counts the number of times a user taps on interactive elements in the widget.

Property

Type

Description

Number of Taps

Number

Count of the number of taps on the widget since the previous Widget Interacted event was fired

🚧

The Widget Interacted event is not fired by default when using widgets with custom user interfaces.

Widget Dismissed

Fired when a user takes an action to dismiss the widget, such as when pressing the dismiss button or swiping it away. This is event is not fired when a widget expires on its own.

Alert Link Opened

Fired when a link on an Alert Widget is opened.

Property

Type

Description

Link URL

String

URL of the link that was opened

Chat Rooms

Keyboard Selected

Fired every time the user opens the keyboard. Has a Keyboard Type property to represent "Sticker" or "Standard" keyboard.

Chat Messages

Each analytics event related to chat messages includes the common properties below.

Property

Type

Description

Chat Room ID

String

Unique identifier of the chat room the message was sent to

Chat Message ID

String

Unique identifier of the chat message

Chat Message Sent

Fired each time user sends a message.

Property

Type

Description

Sticker Shortcodes

List of String

List of shortcodes of each sticker included in the message

Chat Reaction Added

Fired each time user adds reaction to a message.

Property

Type

Description

Chat Reaction ID

String

Unique identifier of the reaction added to the message

Chat Reaction Removed

Fired each time user removes reaction from a message.

Property

Type

Description

Chat Reaction ID

String

Unique identifier of the reaction removed from the message

Chat Reaction Panel Opened

Fired each time user opens reaction panel from a message.

Property

Type

Description

Chat Room ID

String

Unique identifier of the chat room the message was sent to

Chat Message ID

String

Unique identifier of the chat message

Chat Flag Action Selected

Fired when user clicks on flag to block a user/ reports a message.

Property

Type

Description

Reason

String

Reason for blocking a user / reporting message

Chat Message Link Clicked

Fired each time user clicks on a link in a chat message.

Property

Type

Description

Chat Room ID

String

Unique identifier of the chat room the message was sent to

Chat Room Title

String

Title of the Chat room used

Chat Message ID

String

Unique identifier of the chat message

Chat Message Link

String

URL of the link that was opened