Reminders

LAST EDIT Jul 07 2022

Reminders allow you to notify users about messages they did not read. Reminders can be used to trigger an email, push notification or SMS to the user.

When enabled, Stream Chat will send a reminder event to your web-hook or SQS queue every time a user has an unread message in a 1-1 channel for longer than five minutes.

By default reminders will be sent if the user did not read the message within 5 minutes. This interval can be changed for your application. Any interval in seconds between 60 and 86,400 seconds (24 hours) is allowed.

Reminders are configurable as channel type features, by default this feature is disabled. Make sure to enable it for your channel types. This can be done using the API or from the Dashboard.

Reminders are sent only if all conditions are met:

  • The channel has exactly two members

  • The channel type has the reminders feature enabled

  • The channel has at least one unread message

  • The channel has the read_events feature enabled

  • The unread message(s) type is regular or system

  • The unread message is not deleted

  • The channel is not deleted

Reminder Event

Copied!

Reminder events contain all the information needed to send a notification to the user without additional API calls. This makes it easy to pipe email/push/sms services.

Field

Value

type

The type of the event, reminders have type user.unread_message_reminder

user

The target user for this the reminder. This is the user that did not mark the channel as read

channels

The object containing all channels with at least one unread message for this user

created_at

The time the event was sent

The channels object contains up to 10 objects and have this structure

Field

Value

channel

The channel object, this includes the list of members and their read state

messages

The last five messages in the channel (in descending order)