---
title: "Notifications"
---

> Documentation Index
> Fetch the complete documentation index at: https://pupitre.rikology.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notifications

Action handlers (including custom-page actions) receive notification builders. A custom page's `save({ data, ctx })` callback does not receive `notify`. Toasts and persisted inbox messages are distinct delivery paths.

```ts
import { notificationAction } from '@rikology/pupitre'

// Inside a handler with a notify builder:
notify?.success('Saved')
  .body('Your changes are ready.')
  .actions([notificationAction('Open post').url('/admin/posts/1').markAsRead()])
  .send()
```

Available severity methods are success, danger/error, warning and info. `.body()` adds text, `.actions([...])` adds links, `.send()` sends flash/toast feedback. `.sendToDatabase(user?)` persists through the configured notifications adapter; await it. Do not describe a toast as durable delivery.

## Toast duration

Set `toastDuration` on the host's `<Pupitre>` component to auto-dismiss flash and action toasts after a delay in milliseconds:

```tsx
<Pupitre registry={registry} toastDuration={5_000} />
```

The default is `0`: toasts stay visible until dismissed manually or an action is clicked. A positive finite duration enables auto-dismiss; each toast keeps its own deadline across Inertia navigation. Manual dismissal cancels its timer. Changing the setting affects new toasts only; it does not replay the current flash or reschedule existing toasts. Toast state is in memory, not database or localStorage persistence.

## Inbox

Enable panel `.notifications({ interval: 30_000 })`; the default interval is 30 seconds. The tray supports paginated inbox results and marking read. Use `.notifications(false)` to disable it. Without a notifications adapter, database persistence is not available.

The official `notificationsAdapter()` from `@rikology/pupitre/drivers/notifications` integrates `@rikology/adonisjs-notifications`. Configure its database channel/storage in the host. Custom `NotificationsAdapter` implementations provide toInbox, inbox, unreadCount and markRead with the exact normalized message shape in the [configuration reference](/reference/api-configuration/).

Notification actions are serialized labels/URLs/methods/read flags, not callback functions. Use authorized destinations and avoid sensitive record content in user-visible messages.

Source: https://pupitre.rikology.com/guides/notifications/index.mdx