Notifications are scoped per environment. Each environment keeps its own notification types, user preferences, and delivered notifications, so what you configure in
development never leaks into production.What you can do
- Define the kinds of notifications your app sends (a “notification type” such as
build_failedorinvoice_payment), grouped into categories. - Let each user choose what they receive through per-user preferences (turn a type on or off, pick channels like in-app or email).
- Send a notification with a single API call (
emitNotification) — to specific users or to a whole audience. - Show an in-app inbox and receive notifications in real time through a live subscription.
The building blocks
These tables are created for you automatically the first time the Notifications module is activated in an environment. You configure them from the Archie web app or through the GraphQL API — both are covered in the guides below.
Channels
A notification can be delivered through one or more of these channels:Guides
Notification types & categories
Define the catalog of notifications your app can send and organize it into categories.
User preferences
Let your users decide which notifications they receive and on which channels.
Sending notifications
Emit a notification to specific users or to an audience with the
emitNotification mutation.In-app inbox & real-time updates
Show a user’s inbox, mark items as read, and stream new notifications live over a subscription.
A typical flow
- Set up your catalog once. Create the notification types your app needs (or use the ready-made ones that ship with every project) and group them into categories.
- Let users opt in or out. Your users adjust their preferences — for example, “email me about billing, but only show collaboration mentions in the inbox.”
- Send notifications from your app. Whenever something happens, call
emitNotificationwith the type’s key and a target. Archie resolves who should receive it and on which channels, then delivers it. - Show them in your UI. Read the user’s inbox and subscribe to live updates so new notifications appear instantly.