PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome
Community overviewMember access journeySales journeyMoney journeyApps in your communityCommunity notifications

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

Community

Community notifications

What members are told about, and how. The bell, push and email, mentions, channel levels and unread dots, the member's notification settings, the three email switches you control, and every account, billing and balance notification.

Members of your community get notified in three ways: a bell in the community, push notifications on their devices, and email. Which ones they get depends on what happened. Channel activity (mentions, replies and messages) never sends email. Account, billing and balance events can, when you turn those emails on. Apps can add their own bell and push notifications (Apps), and your workflows can send one with the Notify member action.

No community? A workspace that sells with Commerce and has no published community still sends billing, balance (payout) and security notices, by email and in the bell on the buyer's account pages. It starts once the workspace has an address buyers can sign in on, such as a checkout or account domain. Security alerts there link to the Sign-in page. Push is community-only, and so are channel, app and update notifications. A community that is published but whose Community app is turned off sends no community notices; with Commerce on and a checkout or account address, only billing, balance and security notices go out, by bell and email. The email switches below are the same for both apps.

ChannelWhat it isWho controls it
BellA list in the community's top bar, with a count of unread items. Always on.Locked on for most items; each member can turn off an app's items.
PushA notification on the member's phone or computer, even when the community isn't open.Each member, per kind of notification and per device. Needs setup by the administrator.
EmailAn email through your workspace's own sender, for account, billing and balance events.You, with three switches. Each member can turn off single emails.

Bell items are kept for 90 days. A nightly job deletes older ones.


Mentions and replies

Members and staff can mention people in a channel.

WriteWhat happens
@nameTyping @ opens a list of people who can see the channel. The person picked gets a bell item and a push notification.
@everyoneNotifies everyone who can see the channel. Needs the Mention @everyone permission, see below.
#channelBecomes a link to that channel. It never notifies anyone.
A replyReplying to a message notifies its author, exactly like a mention.

The rules:

  • Who is notified. Only people who can see the channel. Mentioning someone who can't see it notifies nobody.
  • Who can be mentioned. Only people who can open the community right now. A member whose plan has lapsed, and a staff member who has never signed in to the community, aren't offered in the @ list and aren't notified.
  • Yourself. A message never notifies its own author.
  • Editing never notifies. Adding a mention in an edit doesn't send anything. Deleting a message removes the bell items it created.
  • Up to 50 people in one message are notified. Mentions inside code are ignored.
  • Apps. A mention of a member in an app's message notifies them, within that app's hourly limit (shared with the app's own notifications, see Apps API) and following the member's In-app and Push switches for that app. An @everyone written by an app never notifies.
  • Staff. Staff get the same bell, push and levels in the community. A direct mention or reply aimed at a staff member is also copied to their Planeward app notifications (in-app only unless they change it there). @everyone is not copied.

Mention @everyone

@everyone is controlled per channel. Open a channel's permissions and look for Mention @everyone. It is off for members by default, and staff can always use it. Without it, @everyone is just text and notifies nobody. Staff don't need the permission, so the dialog says "Staff can always mention @everyone."

A member who doesn't want @everyone notifications can turn on Ignore @everyone in their settings. For that member @everyone creates nothing at all: no bell item, no count, no push.

Sending limits

Each signed-in person, staff included, has their own limits in a community. Two people who share one customer account do not share an allowance:

LimitAllowed
@everyone5 messages an hour
Mentions100 people per 10 minutes, counting a reply to someone else's message as one
Messages40 a minute

Over a limit, the message is refused and not posted. The author sees why (for example "You can use @everyone 5 times an hour") and keeps their draft.


Levels: how much of a channel to follow

Each member sets a level for a channel, or for a whole category.

LevelWhat it does
All messagesEvery ordinary message gives a bell item and a push notification, on top of everything in Mentions only. Pushes collapse per channel.
Mentions onlyThe default. A direct mention, a reply and @everyone give a bell item, a mention count on the channel and a push notification.
MutedLike Discord: no unread dot and no push. A direct mention, a reply or @everyone still creates a bell item, and still counts on the channel's red badge.

A channel's own level beats its category's level, which beats the default (Mentions only). In the sidebar, the ⋯ menu on a channel or category has a Notifications group with these choices and Use category default or Use default. Every member can set them, not only staff. Muted channels show a bell-off icon and dimmed text.

A muted channel still shows its red mention count. It never shows the unread dot, and ordinary messages in it make no bell items.

Unread dots and mention counts

  • Unread dot. A channel with messages the member hasn't read shows a bold name and a marker. A muted channel shows no dot.
  • Mention count. A red number is the unread mentions, replies and @everyone in that channel. It shows on muted channels too. Above 99 it reads 99+.
  • The channel you have open shows neither.
  • A collapsed category shows the sum of its channels' counts.
  • The "Open channels" button on mobile shows a red dot when any other channel has mentions.

Reading is always an explicit action:

  • Opening a channel marks it, and its bell items, read after about half a second.
  • If the tab was in the background, it marks when the member comes back to it. Messages that arrive while someone is looking at the channel are marked after a moment.
  • Mark as read in a channel or category menu, and Mark all read in the bell, do it by hand. Mark all read also clears the channel mention counts.

Messages from before this feature existed, or before a member joined, never count as unread, so nothing starts the day with every channel marked.


What members set: Settings › Notifications

Every signed-in person has a Notifications tab in the community's Settings. Each row has an In-app switch, a Push switch and an Email switch where those apply. A switch that is always on shows as locked ("Always on").

GroupRowsWho sees it
ChannelsMentions (push), All-messages channels (push), and the Ignore @everyone switch. No email.Members and staff
AccountNew-device sign-in, sign-in method added or removed, access suspended, ended or restored, badge awarded.Everyone. Staff see only the two sign-in rows.
BillingRenewed, renewal failed, access expired, receipt approved or rejected, refund issued, cancellation confirmed.The customer's billing owner only
BalanceCommission earned, withdrawal reviewed, balance reduced or adjusted.The balance's owner, and only once they have balance history
AppsOne row per installed app, with In-app and Push switches. No email.Members and staff, when an app is installed
Community updatesNotifications your workflows send with Notify member. Push switch only.Members and staff

Notes:

  • In-app is locked on for Mentions, All-messages channels, Account, Billing, Balance and Community updates. A member can only turn off push, or email. For Apps, In-app is a switch.
  • Locked emails. The new-device sign-in and sign-in method rows have their email locked on. They are security alerts.
  • No email column appears for a group when you have turned that group's emails off, when there is no email sender, or for groups that never email (Channels, Apps, Community updates).
  • Billing and Balance never reach other contacts. A customer can have several contacts, such as the people at a company. Only the customer's own email or primary contact is the billing owner. Money notifications go to that person only, in the bell, in push and in email. Contacts of the same customer share one bell, one set of read marks and one set of levels and settings.
  • Push on this device is a switch at the top of the page. It never asks the browser for permission until the member clicks it. After a member's first bell item, a one-time banner offers it too, and it can be dismissed.

Past customers

A customer whose access lapsed still signs in, to a Settings-only view (Past customers). They get a Notifications tab with Account, Billing and Balance only, no channels, apps or mentions, and a bell limited to those groups. Push works for them too, so a failed renewal or a rejected receipt reaches someone who can't open channels. While their access is lapsed they aren't notified about channels, apps or community updates at all: mentions, @everyone, app notifications and Notify member skip them, and no such push reaches their devices.


Staff setup: the Emails tab

Go to Settings → Apps → Community → Emails. You need Manage community or Manage commerce to change it; teammates without either see it read-only. The same three switches are on Settings → Apps → Commerce → Emails: they are one setting for the whole workspace, shared by both apps. Three switches turn a group of emails on or off for every member and customer:

SwitchEmails it controls
Account emailsAccess suspended, ended or restored, and badges awarded.
Billing emailsRenewals, failed renewals, expired access, bank transfer reviews, refunds and cancellations. Billing owner only.
Balance emailsCommissions earned, withdrawal reviews and balance adjustments. The owner of the balance only.
  • Defaults. Communities that existed before this release start with all three off, so nothing changes until you decide. New communities start with them on.
  • Security emails always send. The new-device sign-in and sign-in method alerts ignore the Account switch and go out whenever your workspace has an email sender. Members of communities that already existed start receiving them when this was released.
  • The bell and push are not affected. They are always on. The switches only control email, and a member can still turn off single emails in their own settings.
  • Your own sender. Notification emails go through your workspace's transactional sender (Settings → Integrations → SMTP), the same way the sign-in email does. With no sender, email is skipped; the bell and push still work. They use the notification's title as the subject and carry a button that opens the page (Open your community, View billing or View balance).
  • No delivery log. Notification emails are not written to the email delivery log, so they don't appear under email deliveries and bounces aren't tracked for them.

Push

Push notifications work in browsers and in installed web apps. They use Web Push, so there is no mobile app to install.

  • Browsers. Chrome and other Chromium browsers, Firefox, Edge and Safari. Brave turns its push service off by default: a Brave user turns on Use Google services for push messaging in Settings → Privacy and security first.
  • iPhone and iPad. Push works only after the member uses Share → Add to Home Screen and opens the community from the home screen icon. Every community serves a web app manifest, with a default icon if you haven't set a logo, so this works everywhere.
  • Per device. A member turns push on for each device. Signing out, or a session ending, stops pushes to that device.
  • Content. The push shows the same title and text as the bell item, shortened to fit, and opens the same page. Items the member already read aren't pushed. All-messages pushes for one channel replace each other.
  • Installed app icon. Where the browser supports it, an installed community shows the unread count on its icon.

The administrator sets it up

Push needs a key pair. Whoever runs your Planeward installation generates it once and sets three environment variables on the web app, all together or none:

npx web-push generate-vapid-keys
VariableValue
WEB_PUSH_VAPID_PUBLIC_KEYThe public key
WEB_PUSH_VAPID_PRIVATE_KEYThe private key
WEB_PUSH_VAPID_SUBJECTA mailto: or https: URL that identifies the administrator

Until all three are set, push is reported unavailable and nothing is sent; the bell, email and everything else work as normal. A blank value fails the web app's environment check, so remove a line rather than leaving it empty. Rotating the keys later makes every existing subscription stop working. A member's browser subscribes again by itself the next time they open the community, with no new permission prompt; until then that device gets no push.


Every account, billing and balance notification

Each of these creates a bell item and a push notification, and an email if the matching switch is on and the member hasn't turned it off. Nothing fires for a community that isn't published, unless the workspace sells through Commerce: then billing, balance and security notices still go out, with no push.

Account

TitleFires whenDoes not fire
New sign-in to communitySomeone signs in from a device (browser, system and device type) the account hasn't used before. Only that person gets it.A first-ever sign-in. A second profile of an already seen browser.
Sign-in method added / removedGoogle, Discord or a passkey is added to or removed from the account. Only that person gets it.A brand new account's first sign-in method.
Your access to community was suspendedStaff suspend the member.
Your access to community endedStaff end the member's access, or it ends for a reason billing doesn't announce.A plan expiring, which sends the billing notification instead.
Your access to community is restoredA suspended or ended membership becomes active again.A first join.
You earned the badge badgeAn app awards the member a badge. Each badge notifies a member once, counts toward that app's limit of 10 notifications an hour per member, and follows the member's In-app and Push switches for that app.The same badge awarded again while the first bell item exists.

The two sign-in alerts are locked on for the bell and for email. Each kind sends at most 6 push notifications and emails an hour to one person; past that, the alert still appears in the bell and nothing else is sent, so a change is never hidden.

Billing

Sent to the customer's billing owner only, and they open Settings → Billing. They cover every plan the customer has in the workspace, including plans that don't unlock the community, so a customer who never joined gets these too when billing emails are on. Complimentary plans notify nobody.

TitleFires when
Your product plan renewedA renewal is paid. The text gives the plan, its list price and the next renewal date.
We couldn't renew your product planA renewal payment fails. See below.
Your product plan expiredA plan ends and its access with it.
Your bank transfer was approved / wasn't approvedYou approve or reject a receipt. A rejection includes your note.
Refund issuedA payment is refunded, in full or in part. A partial refund's text says so when it also ended the plan.
Cancellation scheduled / Your product plan was cancelledA cancel is set to take effect at the end of the period, and then when the plan ends.
  • The rejection note goes to the member. Whatever you type when you reject a receipt is in the bell item, push and email, as Reason: and your text. Write it for them. The same goes for a withdrawal.
  • Failed renewals depend on the processor. Xendit sends it from recurring.cycle.failed, which arrives after the final retry, often days after the period ended, so the member can see "expired" and "couldn't renew" together. For Stripe, add the optional invoice.payment_failed event to your webhook (Payment processors); without it nobody is told about failed Stripe renewals.
  • Cancelling twice in one period notifies once.

Balance

Sent to the owner of the balance, with their own amounts only. The treasury never gets one. They open Settings → Balance.

TitleFires when
You earned amount from productA sale credits a revenue share or commission. The text says which, and when it becomes available. One notification covers a wallet's holder and affiliate shares together.
Withdrawal completed / Withdrawal rejectedYou pay out or reject a withdrawal. A rejection includes the reason you typed, which the member can read.
Your balance was adjustedA refund reverses or cancels earnings, a payment amount changes, or staff add a manual transaction. A manual transaction's text includes the description you entered.

Known limits

  • Stripe failed renewals need the invoice.payment_failed webhook event added by hand. Xendit needs nothing.
  • Mention tokens look raw in the API. Message text is stored with tokens such as @[id]. Apps that read messages through the API or the community.message.created webhook see those tokens and have to replace them.
  • New-device sign-in is a heuristic. It compares browser, operating system and device type. It can miss a second profile of the same browser. In the first minutes after a deploy, a member who signs out and back in may get one false alert.
  • Access notifications can overlap. A lapse can occasionally send both expired and ended. Switching an active subscriber to complimentary access can send restored.
  • Shared customer, shared bell. Contacts of one customer share its bell, read marks, levels and settings.
  • Delivery isn't guaranteed. Push can fail at the browser's push service, and failed pushes aren't retried. The bell item is still there.
  • Billing price. The renewed notification shows the plan's list price, not necessarily the amount charged.
  • Retention. Bell items older than 90 days are gone.

Troubleshooting

A member gets no emails

Check, in order: the matching switch under Settings → Apps → Community → Emails is on (communities that existed before this release start with all three off); the workspace has a transactional email sender; the member hasn't turned that email off in Settings › Notifications; and, for billing and balance emails, that they are the billing owner of their customer. Security alerts need only the sender.

A member gets no push

The administrator must have set the three WEB_PUSH_VAPID_* variables. The member must have turned Push on this device on, and allowed notifications in the browser. On iPhone the community has to be opened from the home screen. A muted channel never pushes, and neither do items the member already read.

A mention didn't notify

The mentioned person must be able to see the channel and open the community right now (a member whose plan lapsed, or staff who never signed in to the community, can't be mentioned), and the mention can't be inside code or an edit. @everyone only counts when the author has Mention @everyone (or is staff) and the reader hasn't turned on Ignore @everyone. A mention in an app's message also needs the app to be under its hourly limit for that person, and the person not to have switched that app off. A message never notifies its own author, and #channel never notifies anyone.

The unread dot stays on

Opening a channel clears it after about half a second. Use Mark as read on the channel's menu, or Mark all read in the bell, if it doesn't. When realtime is down, the bell refreshes about every minute.

Apps in your community

Add tools from other developers to your community, choose what they can access, and remove them.

Support

Send Help, a Bug, or Feedback — and chat when we open a conversation.

On this page

Mentions and repliesMention @everyoneSending limitsLevels: how much of a channel to followUnread dots and mention countsWhat members set: Settings › NotificationsPast customersStaff setup: the Emails tabPushThe administrator sets it upEvery account, billing and balance notificationAccountBillingBalanceKnown limitsTroubleshootingA member gets no emailsA member gets no pushA mention didn't notifyThe unread dot stays on