On this page

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

The Event object has the following properties:

ParameterDescription
Timetoken
Type: FString
Timetoken of the message that triggered an event.
TypeType of action that emits an event: PCET_TYPING, PCET_REPORT, PCET_RECEIPT, PCET_MENTION, PCET_INVITE, PCET_CUSTOM, PCET_MODERATION.
ChannelID
Type: FString
Target channel where this event is delivered.
UserID
Type: FString
Unique ID of the user that triggered the event.
Payload
Type: FString
Data passed in an event that differ depending on the event type.

For details, refer to the chat events documentation.

Use case

Events enable:

  • Collecting historical chat events
  • Creating custom events
  • Building moderation dashboards for flagged messages
  • Triggering business logic with Functions
Last updated on
On this page