Event object

Event represents a single piece of information emitted during chat operations: typing indicators, message receipts, mentions, or reports.

Unlike other Chat SDK entities, Event provides no methods - it only passes payloads emitted during chat operations.

Properties

Event has the following properties:

1class Event<T extends EventType> {
2    timetoken: string
3    type: T
4    payload: EventPayloads[T]
5    channelId: string
6    userId: string
7}

Parameter	Description
timetoken Type: string	Timetoken of the message that triggered an event.
type Type: T	Type of action that emits an event: typing, report, receipt, mention, invite, moderation, or custom.
payload Type: EventPayloads[T]	Data passed in an event that differ depending on the event type.
channelId Type: string	Target channel where this event is delivered.
userId Type: string	Unique ID of the user that triggered the event.

EventType and EventPayloads take the following parameters:

1export type EventType =
2  | "typing"
3  | "report"
4  | "receipt"
5  | "mention"
6  | "invite"
7  | "custom"
8  | "moderation"
9

10...
11

12export type EventPayloads = {
13  typing: TypingEventPayload
14  report: ReportEventPayload
15  receipt: ReceiptEventPayload
16  mention: MentionEventPayload
17  invite: InviteEventPayload
18  moderation: ModerationEventPayload
19  custom: CustomEventPayload
20}
21

22...
23

24type TypingEventPayload = {
25  value: boolean
26}
27type ReportEventPayload = {
28  text?: string
29  reason: string
30  reportedMessageTimetoken?: string
31  reportedMessageChannelId?: string
32  reportedUserId?: string
33}
34type ReceiptEventPayload = {
35  messageTimetoken: string
36}
37type MentionEventPayload = {
38  messageTimetoken: string
39  channel: string
40}
41type InviteEventPayload = {
42  channelType: ChannelType | "unknown"
43  channelId: string
44}
45type ModerationEventPayload = {
46  channelId: string
47  restriction: "muted" | "banned" | "lifted"
48  reason?: string
49}
50type CustomEventPayload = any
51

52export type EventPayloads = {
53  typing: TypingEventPayload
54  report: ReportEventPayload
55  receipt: ReceiptEventPayload
56  mention: MentionEventPayload
57  invite: InviteEventPayload
58  moderation: ModerationEventPayload
59  custom: CustomEventPayload
60}

show all 60 lines

For details, refer to the chat events documentation.

Event structure

Use case

Events enable:

• Collecting historical chat events
• Creating custom events
• Building moderation dashboards for flagged messages
• Triggering business logic with Functions