docs/platform/inbox/features/schedule.mdx
The Schedule feature in the <Inbox /> lets subscribers control when they want to receive notifications from email, SMS, and push channels.
By defining their hours of availability from the <Inbox /> UI, subscribers can automatically skip notifications outside of their chosen time range.
The schedule functionality is based on a clear set of rules controlled by the subscriber within the <Inbox />. When a subscriber enables their schedule, they can then manage their availability for each day of the week.
For any day that the main schedule is active, there will be two possible states:
Day is enabled: If a day is toggled on, then the subscriber must set a time range. Notifications will only be delivered within these hours.
Day is disabled: If a day is toggled off, then the subscriber will not receive any non-critical notifications for that entire day.
The schedule operates in the subscriber's local timezone, detected automatically from their system settings. There is no need for manual configuration.
For example, if a subscriber in Warsaw sets their schedule from 9:00 AM to 5:00 PM, they will receive notifications during those hours in Central European Time (CET).
The schedule UI in the preferences section is designed to be intuitive, giving subscribers several tools to quickly configure their availability.
You can access Schedule from the Preferences section of the <Inbox /> UI. By default, scheduling is turned off, and all notifications will be delivered normally.
The entire feature is controlled by a main schedule toggle. When a subscriber turns this on, they can begin configuring individual days. When it's off, all other settings will be inactive, and notifications will be delivered normally.
For each day of the week, the subscriber can:
Existing availability can be adjusted at any time. Subscribers can:
To make setup faster, subscribers can configure the time for one day and apply it to others in a few clicks:
All changes made in the schedule interface will be saved automatically in the background. The UI updates optimistically, providing a seamless experience without requiring the subscriber to click save.
You can provide a default schedule for your subscribers by passing the defaultSchedule prop to the <Inbox />. This is useful for pre-configuring a recommended schedule that your subscribers can then customize.
This default schedule only applies if a subscriber has not yet configured their own schedule. Once they make any changes, their custom schedule takes precedence.
import { Inbox } from '@novu/react';
function InboxWithDefaultSchedule() {
return (
<Inbox
applicationIdentifier="YOUR_APP_IDENTIFIER"
subscriberId="YOUR_SUBSCRIBER_ID"
defaultSchedule={{
isEnabled: true,
weeklySchedule: {
tuesday: {
isEnabled: true,
hours: [{start: '09:00 AM', end: '07:00 PM'}]
}
}
}}
/>
);
}
export default InboxWithDefaultSchedule;