Skip to content

The dashboard ​

The dashboard at app.<DOMAIN> is the web interface to Notifyzr. It is not a privileged surface: it calls the same public API your own code would, so anything you can do here you can also do from a script.

This section documents the interface — where things are and what each control means. For what the underlying concepts are, read the Guide; for request and response shapes, the API reference.

The layout ​

Every page inside an organization has the same three frames.

FrameWhat lives there
Top barThe command menu, the notification bell, a link to these docs, and your account menu (profile image, Account settings, Log out).
Sidebar (desktop)The organization switcher, then the organization's pages. On narrow screens this becomes a horizontal scroller under the top bar.
The page itselfWhatever you navigated to. Announcement banners sit above it and scroll away with the page, rather than pinning to the top forever.

The sidebar's pages are, in order: Overview, Messages, Contacts, Templates, Channels, Domains, Forms, Automations, Broadcasts, Webhooks, API keys, Activity, Settings.

API keys and Activity are shown to Admins and Owners only — the log names who removed whom and who revoked which key, and the endpoints behind both refuse a Member anyway. There is no Members entry: the roster is a tab inside Settings, so every member can reach it.

The command menu ​

Ctrl K (⌘ K on macOS) opens a command palette from anywhere. It has four groups:

  • Create & Quick Actions — send a message, build a lead form, add a contact, new email template, connect a channel, add a sending domain, create a webhook endpoint, generate an API key, new broadcast.
  • Navigation — jump to any page of the current organization, or to your account settings.
  • Help — this documentation, the guide, the API reference, and the support dialog.
  • Appearance — switch between light and dark.

Because every create action is a URL, the palette navigates rather than opening a floating state — the dialog it lands on is linkable and closes with Back.

The organization switcher ​

At the top of the sidebar. It lists every organization you are a member of with its logo, name and a line of its description, and it stays usable even when the organization you are currently on fails to load — it is the way out of a not-found organization.

Two extra controls live in it:

  • The star on each row sets your default organization — the one sign-in lands you in.
  • Create organization in the footer, hidden while you own one you created yourself.

The Overview ​

The first page of every organization is a grid of widgets over six columns. Each widget can be added, removed, reordered by dragging, and set to span anywhere from one column to the full six. Below a desktop width the grid collapses, so a phone always gets a readable single stack.

There are two layers, and yours wins:

LayerWho sets itWho sees it
Organization defaultOwners and AdminsEveryone who has not customized
My viewEvery member, Viewers includedOnly you, on every device you sign in from

Press Customize to edit. Owners and Admins get a second control choosing which layer they are editing; everyone else edits their own view and nothing else. Arranging your own Overview is not a write to the organization — it changes nothing anyone else sees — which is why the read-only Viewer role can still do it.

Once you have customized, later changes an admin makes to the organization default will not move your page; that is the point of having your own layer. Reset to organization default gives up your layer and puts you back on theirs.

Your layout is stored on your account rather than in the browser, so it follows you between devices. Removing every widget is a legitimate choice and is remembered as one — the page will not quietly restore itself on the next load.

Add widget offers everything not already on the page:

WidgetWhat it shows
Headline tilesOne number each: contacts, messages, broadcasts, active automations, form submissions, sending domains, templates, channels, webhooks, API keys.
Message deliverySends and their outcome over the window chosen in the toolbar.
Automation runs, By triggerRuns in that window, broken down by automation and by the event that fired them.
By sending domain, By channelWhere the messages in that window went out over.
Platform Health & InfrastructureDomain verification rate, with counts of webhooks and keys.
Active Funnels & AutomationsThe latest broadcasts and the automations currently switched on.
Recent messagesThe last few sends with recipient, status and a link to each.
Broadcast performanceRecent broadcasts with how much of each audience was delivered to.
Domain healthEvery sending domain's verification status, and which DNS records the last check could not find.
Plan usageHow much of each plan limit is used, amber from 80% and red at the ceiling.
TeamMembers with their roles, plus invitations nobody has answered yet.
Recent activityThe last few logged changes and who made them. Owners and Admins only.
Expiring API keysKeys within two weeks of expires_at, and any already past it. Owners and Admins only.
Quick actionsShortcuts into the create forms — the same set the command menu offers. Not offered to Viewers, who cannot create anything.

Two of these read data the API refuses below Admin, and one offers nothing but writes, so the picker does not list them to a member who could not use them. A widget an admin put on the organization default is simply left out of that member's page rather than shown as an error.

A widget only fetches what it draws, so a page you have trimmed down loads less than the full one — and the time-range control in the toolbar appears only when something on screen actually answers to it.

Notifications, announcements and release notes ​

Three things around the edges of the dashboard are easy to confuse. They are separate on purpose.

WhereTells you
Announcement bannerUnder the top bar, on every pageSomething the people running this instance want everyone to know — maintenance, an incident
Notification bellTop barThings waiting on you: an invitation to answer, a change in an organization you administer, advice about your account
What's newAccount menu, and the build stamp in the sidebarWhat changed in the version of Notifyzr you are running

The bell merges three sources: organization invitations addressed to you, notable activity in the organizations you administer (never your own actions), and standing advice about your account — two-factor being off, or a deletion being scheduled. Entries retract themselves: accept the invitation and it is simply not in the next answer. Entries link to the page that can act on them rather than acting in the popover. Read state is stored per device, and reading one does not dismiss it — it only stops it counting toward the dot.

What's new describes exactly the build you are running, which is what the build stamp at the bottom of the sidebar promises too. The dot is keyed on the newest released version, so an install tracking main does not carry a permanent unread marker for [Unreleased].

Almost everything you see is in the URL, which means you can bookmark it, reload it, and send it to a colleague.

Forms have their own address. Opening "New contact" takes you to /contacts/new; editing one takes you to /contacts/<id>/edit. Same for importing contacts, composing a broadcast, creating a template, testing a channel, editing an API key. So a half-filled form survives a reload, and Back closes it instead of reopening the one before.

Filters and tabs are query parameters — ?tab=, ?folder=, and every list filter. Switching a tab does not add a history entry, so Back walks between pages rather than stepping back through tabs you clicked.

The exception is confirmation dialogs, which are not linkable. A URL that says "delete" is not somewhere you want to land by reloading.

Read-only access ​

If your role in an organization is Viewer, no page is hidden from you — reading the whole dashboard is the role. Instead, a strip above the page explains that your role is read-only, and the controls that would write are not offered. See Roles.

Where to go next ​

Released under the Apache 2.0 License.