Apps in your community
Add tools from other developers to your community, choose what they can access, and remove them.
Apps are tools built by other developers, like polls, leaderboards or booking forms, that run inside your community. Each app shows up as a channel your members open like any other channel. Some apps also have a dashboard for your staff.
Before you start
- Your workspace needs Community turned on (Business plan or higher). Apps live in the community only: Commerce alone doesn't run them, and your checkout and account addresses send community pages to the community address.
- You need the Manage community permission. See roles and permissions.
Install an app
You install an app from an install link the developer gives you, or from Official apps.
- Open the install link. Or go to Community › Apps, paste the link into Install from link and select Continue. Apps recommended by Planeward are listed under Official apps on the same page.
- Check who made the app and where it appears: a member channel, plus a staff dashboard if it has one.
- Pick the Workspace to install it in.
- Review what the app is asking to do. Untick anything you don't want to allow. The app may not work fully without it.
- Select Install.
If you see This install link is invalid or expired, ask the developer for a new link.
Add it to your community
Installing doesn't show the app to members yet.
- In Community › Apps, open the app's ⋯ menu and select Add as channel.
- Name the channel, pick a category, optionally add a description, and select Add channel.
The channel appears in your community's sidebar for everyone who can see that category. You can add the same app as more than one channel, for example one per topic.
Staff dashboard
If the app has a dashboard, select Open dashboard on its row in Community › Apps. Only people with Manage community see it.
What an app can see and do
When someone opens an app, Planeward tells the app:
- their display name and avatar;
- whether they are a member or staff;
- which channel they opened.
Members don't sign in to the app separately, and the app never receives passwords or email addresses this way.
Everything else depends on what you allowed when installing:
| Permission | What the app can do |
|---|---|
| Community — read members | List your community's members: username, display name, avatar, status, access plans, roles and badges. Never email addresses. The app is also told when a membership starts, is paused, resumes or ends, and when a badge is awarded or revoked. |
| Community — read public channels and messages | Read channels everyone in the community can see, their messages and reactions, and be told about new ones. Private channels and channels limited to some roles stay hidden. |
| Community — post messages as the app | Post messages in text channels that everyone in the community can post in. The messages show the app's name with an APP badge. Members can't edit them; moderators can delete them like any other message. |
| Community — read courses and member progress | Read the outline of courses members can see (published and sold through a product; titles and descriptions, not lesson content) and which modules each member has completed in them. |
| Community — update member course progress | Mark modules complete or not complete for a member, in any course members can see, whatever their plan unlocks. |
| Events — read | List events you turned Show in community apps on for, and be told when members register, cancel or attend. Apps never see the event's pipeline or deals, or its form unless that form is shown in community apps too. |
| Events — register, cancel and mark attendance | Register members for those events, cancel their registration and set their attendance. |
| Forms — submit as a member | List forms you turned Show in community apps on for, and submit them for a member. Submissions run your normal form workflows. |
| Community — manage and award badges | Create its own badges and award them to members. See Badges. |
| Community — send notifications to members | Send a member a notification in their bell and as a push notification, titled with the app's name. Never by email. See Notifications. |
Registering a member for an event or submitting a form for them adds the member to your CRM as a contact if they aren't one yet. If the member's customer has no primary contact, Planeward uses the customer's contact with the customer's own email, or creates one from the customer record. It never makes another person on the customer (a partner or assistant) the primary contact, and never changes the customer's email, phone or role. A customer with no email but other contacts can't be picked for: set its email or primary contact in the CRM first. Apps can only do these for active members, never suspended or removed ones.
Apps can't give consent for a member. A form submitted by an app stores every answer, but marketing consent, guardian consent and the guardian email are not set on the contact; only the member can give them, by filling in a form themselves.
Apps can't reach anything else in your workspace, such as customers, invoices, chats, settings, other events or forms, or form answers. The app is also told when it's installed and uninstalled.
Apps are built and run by their developers, not by Planeward. Anything members type into an app is stored by that developer. Only install apps from developers you trust, and check their privacy policy.
Share events and forms with apps
Apps never see your events or forms until you choose them.
- Event: in CRM → Events, edit the event and turn on Show in community apps.
- Form: open the form's Settings and turn on Show in community apps under Publish. Only published forms are shown.
Turn it off to hide the event or form from every app again.
Badges
Apps with the badges permission can award badges, for example First post or Course finished. A member's badges show on their profile and in the member list, labelled with the app that gave them, and their newest badge shows next to their name in chat.
Each app can create up to 50 badges. Badges disappear when you uninstall the app and come back, with the same members, if you install it again.
Notifications
Apps with the notifications permission can notify members, for example about an order, a booking or a result. Each notification shows in the member's bell and as a push notification, always titled with the app's name. Planeward sets the title, so an app can't pretend to be someone else. Apps never send email through this.
- A click opens the app's channel with the app at the page the notification is about.
- An app can send a member up to 10 notifications an hour. Past that, more are dropped until the hour is up.
- Members control it. In Settings › Notifications, under Apps, each installed app has its own In-app and Push switches. An app never learns who turned it off.
- An app can only notify active members, never staff, and only while it has a channel that everyone in the community can see.
The bell, push and each member's settings are covered in Community notifications.
Approve new permissions
A developer can ask for more permissions after you installed an app. The new ones stay off until you approve them, and you don't need to reinstall.
- In Community › Apps, an app that is asking for more shows Permissions to review and the message that it is asking for permissions you haven't approved.
- Select Review new permissions. The dialog lists each permission, ticked.
- Untick any you don't want to allow and select Approve.
The permissions take effect at once, and the app's channels stay as they are. If you leave some unticked, the review message stays for those. The app isn't told when you approve; it finds out when a call that failed starts to work. Approving also lets the app receive the events that permission covers. The approval is recorded in the audit log with the permissions that were approved.
You need Manage community to review permissions. Permissions you unticked when installing also show up here, since Planeward doesn't tell them apart from new ones. The message is worded to cover both.
Local dev apps
An app marked Local dev in the sidebar is being built by someone in your workspace and runs on their own computer, so it only loads for them. Its install page says Local development, and it can't be installed in any other workspace. While it's being built, keep its channel in a category only staff can see.
An app's lifecycle
Uninstalling at any point removes the app's channels and ends its access. Messages it already posted stay.
Remove an app
In Community › Apps, open the app's ⋯ menu and select Uninstall.
- Its channels are removed from your community.
- Its access to your workspace ends right away.
- Its badges are hidden from profiles, the member list and chat.
- Messages it already posted stay.
You can install it again later. Add it as a channel again; its badges come back with their members.
When an app says Unavailable
If the developer turns an app off, it shows Unavailable in Community › Apps and can no longer be opened. Members stop seeing its channels. Staff still see them, marked unavailable, so they can clean up. Select Uninstall to remove its channels.
What members see
- App channels sit in the sidebar with the app's icon instead of
#. - Opening one shows the app inside the community. There's nothing to install and no extra sign-in.
- Messages posted by an app show an APP badge next to its name.
- Badges from apps show on member profiles, in the member list and next to names in chat.
- Apps that send notifications show in the bell and as push notifications, titled with the app's name. Under Settings › Notifications, each installed app has In-app and Push switches.
- This app is no longer available means it was removed or turned off.
Building an app?
See Community apps for developers. The app template and the @planeward/sdk package get you started.
Money journey
How a customer's payment becomes revenue-share credits on your treasury and member accounts, when it can be withdrawn, and how refunds, chargebacks and manual transactions change it.
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.
Planeward Docs