Create custom events

Learn how Chat SDK handles events before creating your own custom chat events.

Event handling

PubNub events

With a standard PubNub SDK like the JavaScript SDK, building a chat app requires additional steps:

• Subscribe to channels to receive messages
• Add event listeners to handle messages, signals, and events

Chat SDK handles this automatically. All listener methods return a function to stop receiving events and unsubscribe from the channel.

Entity	Method	Events handled
Channel	streamUpdates() or streamUpdatesOn()	(Un)Subscribe the current user to/from a channel and start/stop getting all objects events of type channel.
User	streamUpdates() or streamUpdatesOn()	(Un)Subscribe the current user to/from a channel and start/stop getting all objects events of type uuid.
Message	streamUpdates() or streamUpdatesOn()	(Un)Subscribe the current user to/from a channel and start/stop getting all messageAction events (for message and message actions changes) of type added or removed.
Membership	streamUpdates() or streamUpdatesOn()	(Un)Subscribe the current user to/from a channel and start/stop getting all objects events of type membership.
Channel	connect()	(Un)Subscribe the current user to/from a channel and start/stop getting all message events of type text.
Channel	getTyping()	(Un)Subscribe the current user to/from a channel and start/stop getting all signal events of type typing.
Channel	streamPresence()	(Un)Subscribe the current user to/from a channel and start/stop getting all presence events of type action (responsible for monitoring when users join, leave the channels, or when their channel connection times out and they get disconnected).

Chat SDK wraps server responses into entities like Channel, Message, and User with methods and properties for building your app's UI.

Chat events

Events are separate entities that carry data payloads and can trigger business logic (for example, the Typing Indicator starts or stops based on typing events).

Chat SDK automatically emits these event types when a user:

• Reports a message (report event type)
• Starts/Stops typing a message on a channel (typing event type)
• Mentions someone else in the message (mention event type)
• Reads a message published on a channel (receipt event type)
• Invites another user to join a channel (invite event type)
• Mutes a user, bans them, or removes these restrictions (moderation event type)

All event types use the PubNub Pub/Sub API with one of these methods:

• publish() - for events requiring history (always enabled in Chat SDK)
• signal() - for short-lived events without history (for example, typing indicators)

Listen to events with:

• listenForEvents() - for current events emitted via signal() or publish()
• getEventsHistory() - for historical events emitted via publish()

note

getEventsHistory() cannot filter by event type. It returns all events emitted via publish() on the channel within the specified timeframe.

Each event type has a fixed payload structure documented below.

Events for reported messages

• Type: report
• PubNub method: PubNub method used to send events you listen for. publish() (with history) is used for all events related to message reporting.
• Target: PUBNUB_INTERNAL_MODERATION_{channel_id}
• Trigger: report() method on the Message object
• Listener: streamMessageReports() (current) and getMessageReportsHistory (historical)
• Sample use case: Message moderation. You might want to create a UI for an operational dashboard to monitor and manage all reported messages.
• Payload:

1type ReportEventPayload = {
2    // content of the flagged message
3    text?: string
4    // reason for flagging the message
5    reason: string
6    // timetoken of the flagged message
7    reportedMessageTimetoken?: string
8    // channel where message was flagged
9    reportedMessageChannelId?: string
10    // author of the flagged message
11    reportedUserId?: string
12}

Events for typing indicator

• Type: typing
• PubNub method: PubNub method used to send events you listen for. signal() (without history) is used for all events related to typing.
• Target: The same channel where messages are published.
• Trigger: startTyping() and stopTyping() methods on the Channel object
• Listener: getTyping() on the Channel object
• Sample use case: Typing indicator. You might want to show graphically on the channel that another channel member is typing or has stopped typing a message.
• Payload:

1type TypingEventPayload = {
2    // value showing whether someone is typing or not
3    value: boolean
4}

Events for mentions

• Type: mention
• PubNub method: PubNub method used to send events you listen for. publish() (with history) is used for all events related to mentions.
• Target: Unlike in other event types, a target for mention events is equal to a user ID. This ID is treated as a user-specific channel and is used to send system notifications about changes concerning a User object, such as creating, updating, or deleting that user. The channel name is equal to the ID (id) of the user and you can retrieve it by calling the currentUser method on the Chat object.
• Trigger: sendText() method on the Channel object
• Listener: listenForEvents() (current) or getEventsHistory() (historical) on the Chat object
• Sample use case: User mentions. You might want to receive notifications for all events emitted when you are mentioned in a parent or thread channel.
• Payload:

1type MentionEventPayload = {
2    // timetoken of the message where someone is mentioned
3    messageTimetoken: string
4    // channel on which the message with mention was sent
5    channel: string
6}

Events for read receipts

• Type: receipt
• PubNub method: PubNub method used to send events you listen for. signal() (with history persisted as the last read message on the Membership object) is used for all events related to message read receipts.
• Target: The same channel where messages are published.
• Trigger: markAllMessagesAsRead() method on the Chat object, the setLastReadMessageTimetoken() method on the Membership object, and the setLastReadMessage() method on the Membership object
• Listener: streamReadReceipts() (current) on the Chat object
• Sample use case: Read receipts. You might want to indicate on a channel - through avatars or some other indicator - that a message was read by another user/other users.
• Payload:

1type ReceiptEventPayload = {
2    // timetoken of the read message
3    messageTimetoken: string
4}

Events for channel initations

• Type: invite
• PubNub method: PubNub method used to send events you listen for. publish() (with history) is used for all events related to channel invitations.
• Target: An event is sent to the ID of the invited user (user channel with the name same as the user ID).
• Trigger: invite() and inviteMultiple methods on the Channel object
• Listener: listenForEvents() (current) or getEventsHistory() (historical) on the Chat object
• Sample use case: Channel invitations. You might want to notify users that they were invited to join a channel.
• Payload:

1type InviteEventPayload = {
2    // type of a channel to which a user was invited (direct or group)
3    channelType: ChannelType || "unknown"
4    // ID of the channel to which a user was invited
5    channelId: string
6}

Events for user moderation

• Type: moderation
• PubNub method: PubNub method used to send events you listen for. publish() (with history) is used for all events related to user restrictions.
• Target: An event is sent to the PUBNUB_INTERNAL_MODERATION.[user_id] channel, where user_id is the ID of the moderated user.
• Trigger: setRestrictions() methods on the Channel, Chat, and User objects
• Listener: listenForEvents() (current) or getEventsHistory() (historical) on the Chat object
• Sample use case: User moderation. You might want to notify users when they were muted, banned, or when you remove these restrictions from them.
• Payload:

1type ModerationEventPayload = {
2  // ID of the channel on which the user's moderation restrictions were set or lifted
3  channelId: PUBNUB_INTERNAL_MODERATION.[string]
4  // type of restriction: whether a user was muted, banned, or at least one of these restrictions was removed
5  restriction: "muted" | "banned" | "lifted"
6  // reason for muting or banning the user
7  reason?: string
8}

Custom events

The custom event type carries custom payloads for additional business logic. Methods:

• emitEvent() - create and send custom events
• listenForEvents() - listen for incoming events
• getEventsHistory() - retrieve historical events

Create and send events

emitEvent() constructs and sends events with your custom payload, similar to sendText() for messages.

emitEvent() calls Pub/Sub API and the JavaScript SDK publish() or signal() method.

Under the hood

Method signature

This method takes the following parameters:

1chat.emitEvent({
2    // in case of "mention" events
3    user: string;
4    // for every other type of event
5    channel: string;
6    type: "typing" | "report" | "receipt" | "mention" | "invite" | "moderation" | "custom";
7    // only respected for "custom" events
8    method?: "signal" | "publish";
9    payload: EventPayloads["type"] | any;
10}): Promise<PubNub.SignalResponse> | Promise<PubNub.PublishResponse>

Input

* required

Parameter	Description
user Type: string Default: n/a	User for which the mention is emitted.
channel Type: string Default: n/a	Channel where you want to send the events.
type * Type: string Default: n/a	Type of events. Use custom for full control over event payload and emitting method.
method Type: string Default: n/a	PubNub method you want to use to send your events. You can choose between the signal() method for small-sized and short-lived events or publish() method for events with larger payload that you want to store in history (Chat SDK enables history for events on the publish() method by default). Read PubNub docs for differences between messages and signals.
payload * Type: EventPayloads[type] or any Default: n/a	Metadata in the form of key-value pairs you want to pass as events from your chat app. Can contain anything in case of custom events, but has a predefined struture for other types of events.

Output

Type	Description
Promise<PubNub.SignalResponse> or Promise<PubNub.PublishResponse>	Result of the PubNub Publish or Signal call.

Sample code

You want to monitor a high-priority channel with a keyword spotter that identifies dissatisfaction words like "annoyed," "frustrated," or "angry." Suppose a message sent by any of the customers present on this channel contains any of these words. In that case, you want to resend it (with relevant metadata) to a separate technical channel (CUSTOMER-SATISFACTION-CREW) that's monitored by the team responsible for customer satisfaction.

1chat.emitEvent({
2    channel: "CUSTOMER-SATISFACTION-CREW";
3    type: "custom";
4    method: "publish"
5    payload: {
6        "chatID": "chat1234",
7        "timestamp": "2022-04-30T10:30:00Z",
8        "customerID": "customer5678",
9        "triggerWord": "frustrated"
10    };
11}): any

Receive current events

listenForEvents() watches a channel for new custom events and handles them via a callback, similar to connect() for messages.

listenForEvents() calls Pub/Sub API and the JavaScript SDK subscribe() and unsubscribe() methods.

Under the hood

Method signature

This method takes the following parameters:

1chat.listenForEvents<"type">({
2    // in case of "mention" events
3    user: string;
4    // for every other type of event
5    channel: string;
6    type: "typing" | "report" | "receipt" | "mention" | "invite" | "moderation" | "custom";
7    // only respected for "custom" events
8    method?: "signal" | "publish";
9    callback: (event: Event<"type">) => unknown;
10}): () => void

Input

* required

Parameter	Description
user Type: string Default: n/a	User whose mention events you want to listen for.
channel Type: string Default: n/a	Channel you want to listen to for events.
type * Type: string Default: n/a	Type of events to listen for.
method Type: string Default: n/a	PubNub method used to send events you listen for.
callback * Type: (event: Event<"type">) => unknown Default: n/a	Callback function passed as a parameter. It defines the custom behavior to be executed whenever an event is detected on the specified channel.

Output

Type	Description
() => void	Function you can call to disconnect (unsubscribe) from the channel and stop receiving events.

Sample code

Monitor a channel for frustrated customer events. When such an event occurs, the handleFrustratedEvent function responds with a message acknowledging the customer's frustration and offering assistance.

1// simulated event data received
2const eventData = {
3    "chatID": "chat1234",
4    "timestamp": "2022-04-30T10:30:00Z",
5    "customerID": "customer5678",
6    "triggerWord": "frustrated"
7};
8

9// example function to handle the "frustrated" event and satisfy the customer
10function handleFrustratedEvent(eventData) {
11    // extract relevant information from the event data
12    const customerID = eventData.customerID;
13    const timestamp = eventData.timestamp;
14    const triggerWord = eventData.triggerWord;
15

16    // create a response
17    const response = `Thank you for reaching out. We're sorry to hear that you're ${triggerWord}. Our team is here to help and will work to resolve your concerns as quickly as possible. Your satisfaction is important to us.`;
18

19    // send the response back to the customer's chat
20    sendResponseToCustomerChat(customerID, timestamp, response);
21}
22

23

24// example event listener using "listenForEvents()"
25const eventListener = chat.listenForEvents({
26    channel: "CUSTOMER-SATISFACTION-CREW",
27    type: "custom",
28    method: "publish",
29    callback: (event) => {
30        if (event.triggerWord === "frustrated") {
31            handleFrustratedEvent(event);
32        }
33    }
34});
35

36// simulate triggering the event callback with the example event data
37eventListener(eventData);

show all 37 lines

Get historical events

getEventsHistory() retrieves historical events from a channel, similar to getHistory() for messages. Results cannot be filtered by type and include all events emitted via publish() in the specified timeframe.

getEventsHistory() calls Message Persistence API and the JavaScript SDK fetchMessages() method.

Under the hood

Method signature

This method takes the following parameters:

1chat.getEventsHistory({
2    channel: string;
3    startTimetoken?: string;
4    endTimetoken?: string;
5    count?: number;
6}): Promise<{
7    events: Event[];
8    isMore: boolean;
9}>

Input

* required

Parameter	Description
channel * Type: string Default: n/a	Channel from which you want to pull historical messages.
startTimetoken Type: string Default: n/a	Timetoken delimiting the start of a time slice (exclusive) to pull events from. For details, refer to the Fetch History section.
endTimetoken Type: string Default: n/a	Timetoken delimiting the end of a time slice (inclusive) to pull events from. For details, refer to the Fetch History section.
count Type: number Default: 100	Number of historical events to return for the channel in a single call. You can pull a maximum number of 100 events in a single call.

Output

Parameter	Description
Promise<> Type: object	Returned object containing two fields: events and isMore.
→ events Type: Event[]	Array listing the requested number of historical events objects.
→ isMore Type: boolean	Info whether there are more historical events to pull.

Sample code

Fetch the last 10 historical events from the CUSTOMER-SATISFACTION-CREW channel.

1chat.getEventsHistory(
2    {
3        channel: "CUSTOMER-SATISFACTION-CREW"
4        count: 10
5    }
6)

Events for reported users (deprecated)

• Type: report
• PubNub method: PubNub method used to send events you listen for. publish() (with history) is used for all events related to user reporting.
• Target: PUBNUB_INTERNAL_ADMIN_CHANNEL
• Trigger: DEPRECATED_report() method on the User object
• Listener: listenForEvents() (current) or getEventsHistory() (historical) on the Chat object
• Sample use case: User moderation. You might want to create a UI for an operational dashboard to monitor and manage all reported users.
• Payload:

1payload: {
2    // reason for flagging the user
3    reason: string;
4    // flagged user
5    reportedUserId: string;
6}