Skip to main content

Notifications

Notifications inform users of actions that occurred in a context different from their current context. ChatKitty sends notifications to your app through the ChatKitty JavaScript SDK when an action outside of an active chat session occurs. You can observe these notifications and use them to build in-app notification views. ChatKitty also sends notifications to chat functions that can be used to trigger push notifications.

Properties

NameTypeDescriptionRequired
idnumber64-bit integer identifier associated with this notification
titlestringTitle of this notification briefly informing the user what occurred
bodystringDetailed message informing the user what occurred triggering this notification
dataNotificationDataAdditional data related to this notification, including its type
mutedbooleanTrue if this notification is muted and should not actively notify the recipient user of its related event-
createdTimedatetimeISO 8601 date-time when this notification was created
readTimedatetimeISO 8601 date-time when this notification was read-

Notification types

User sent message

Sent when another user sends a message in a channel the recipient is a member of but currently has no active chat sessions.

Notification data

NameTypeDescriptionRequired
typestringAlways USER:SENT:MESSAGE
messageMessageThe message that was sent
channelIdnumber64-bit integer identifier of the channel this notification is related to

System sent message

Sent when a system message is sent using the Platform REST API in a channel the recipient is a member of but currently has no active chat sessions.

Notification data

NameTypeDescriptionRequired
typestringAlways SYSTEM:SENT:MESSAGE
messageMessageThe message that was sent
channelIdnumber64-bit integer identifier of the channel this notification is related to

User mentioned channel

Sent when another user mentions a channel the recipient is a member of, in a channel accessible to the recipient.

Notification data

NameTypeDescriptionRequired
typestringAlways USER:MENTIONED:CHANNEL
messageMessageThe mentioning message
channelIdnumber64-bit integer identifier of the channel with the mentioning message
mentionedChannelChannelThe channel that was mentioned

User mentioned user

Sent when another user mentions the recipient in a channel accessible to the recipient.

Notification data

NameTypeDescriptionRequired
typestringAlways USER:MENTIONED:USER
messageMessageThe mentioning message
channelIdnumber64-bit integer identifier of the channel with the mentioning message
mentionedUserChannelThe user that was mentioned