Skip to content

Commit 6e97b2b

Browse files
danciaclaradanciaclara
authored
Added Subscribers and Notifications pages (#439)
1 parent e4b52b5 commit 6e97b2b

8 files changed

Lines changed: 292 additions & 55 deletions

File tree

‎docs/.vitepress/config.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ export default defineConfig({
527527
],
528528
},
529529
{
530-
text: "Collaboration",
530+
text: "Communication",
531531
items: [
532532
{
533533
text: "Project Updates",
@@ -541,7 +541,9 @@ export default defineConfig({
541541
text: "Page Inline Comments",
542542
link: "/core-concepts/pages/inline-comments",
543543
},
544-
{ text: "Inbox", link: "/core-concepts/inbox" },
544+
{ text: "Subscribers", link: "/communication-and-collaboration/subscribers" },
545+
{ text: "Notifications", link: "/communication-and-collaboration/notifications" },
546+
{ text: "Inbox", link: "/communication-and-collaboration/inbox" },
545547
],
546548
},
547549
{

‎docs/automations/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Auto-close moves unfinished work items — those in Backlog, Unstarted, or Start
4040
3. Set the **Auto-close work items that are inactive for** duration — for example, 1 month.
4141
4. Choose the **Auto-close status** — the state that inactive work items will be moved to (e.g., Cancelled).
4242

43-
### Set up due date reminders <Badge type="tip" text="Business" />
43+
### Set up due date reminders <Badge type="warning" text="Enterprise Grid" />
4444

4545
Plane sends in-app and email notifications to assignees and subscribers when a work item's due date is approaching.
4646

‎docs/communication-and-collaboration/inbox.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Notifications Inbox
3+
description: Learn how to use Plane's notifications inbox — filter by type, mark as read, snooze, archive, and use stacked notifications to quickly catch up on work item activity.
4+
---
5+
6+
# Inbox
7+
8+
The Inbox is a space for tracking and managing updates to work items you're connected with. Whether you're assigned to a work item, its creator, mentioned in a discussion, or subscribed to its updates, you'll find everything here. It's where all your in-app notifications live.
9+
10+
The inbox has two tabs: **All** and **Mentions**. Each tracks its own unread count. The sidebar icon shows a red dot when either tab has unread notifications.
11+
12+
## Where to find Inbox
13+
14+
Click the **Notifications** icon in the top right of the screen to open the inbox. Clicking a notification opens the work item in a panel on the right — you stay in the inbox.
15+
16+
![Inbox](https://media.docs.plane.so/inbox/inbox.webp#hero)
17+
18+
Use the **All** tab for everything except @-mentions — state changes, field updates, comments, assignments. Use the **Mentions** tab to see only notifications where someone @-tagged you.
19+
20+
::: tip Email notifications
21+
All inbox notifications are also sent to your email by default. You can [customize your email notification preferences](/communication-and-collaboration/notifications#set-your-notification-preferences) in Profile Settings.
22+
:::
23+
24+
### Manage notifications in your inbox
25+
26+
Hover over any notification card to reveal three action buttons:
27+
28+
- **Mark read / unread** — toggles the unread indicator
29+
- **Archive** — removes it from your default view; you can still find archived notifications by turning on Show archived in the menu
30+
- **Snooze** — hides it until a time you choose
31+
32+
To clear everything at once, use **Mark all as read** in the inbox header.
33+
34+
### Filter your notifications
35+
36+
Use the **filter icon** to narrow by type — you can combine multiple filters:
37+
38+
- **Assigned to me** — notifications for work items where you're an assignee
39+
- **Created by me** — notifications for work items you created
40+
- **Subscribed by me** — notifications for items you're subscribed to but didn't create or get assigned to
41+
42+
Use the **three-dot menu** to toggle display options — only one can be active at a time:
43+
44+
- **Show unread** — only unread notifications
45+
- **Show archived** — only archived notifications
46+
- **Show snoozed** — only snoozed notifications, including ones whose snooze time has already passed
47+
48+
Active filters appear as tags below the tab bar. Remove them individually or clear all at once.
49+
50+
## Notification card content
51+
52+
Each notification card shows:
53+
54+
- **Who did it** — the actor's avatar (or a bell icon for due date reminders)
55+
- **What they did** — a one-line summary, e.g. "Alice added assignee Bob" or "Carol set due date to Jan 15"
56+
- **Which work item** — the project identifier and sequence number, and the work item name
57+
- **When** — a relative timestamp, e.g. "3 hours ago"
58+
- **Unread dot** — a small coloured dot on the left edge when unread
59+
- **Snoozed indicator** — if snoozed, the timestamp is replaced with "Till {date}, {time}"
60+
61+
## Snooze options
62+
63+
| Option | Hides until |
64+
| ------- | ------------------------- |
65+
| 1 day | Tomorrow at the same time |
66+
| 3 days | Three days from now |
67+
| 5 days | Five days from now |
68+
| 1 week | One week from now |
69+
| 2 weeks | Two weeks from now |
70+
| Custom | A date and time you pick |
71+
72+
## Stacked notifications <Badge type="info" text="Pro" />
73+
74+
Notifications are grouped by work item. Instead of one card per event, you get one card per work item covering all the changes to it.
75+
76+
The stacked card shows:
77+
78+
- The work item name and identifier
79+
- Avatars of everyone who made changes
80+
- An unread count badge for the group
81+
- The time of the most recent notification
82+
83+
Hovering over a stacked card opens a preview showing all the individual changes inside it — each one with the actor, what changed, and when.
84+
85+
Clicking a stacked card marks all grouped notifications as read and, in full-page view, opens the work item with the relevant activity items scrolled into view and highlighted. The highlight fades after 5 seconds.
86+
87+
Actions on a stacked card — read/unread, archive, snooze — apply to all notifications in the group at once.
88+
89+
## See also
90+
91+
- [Subscribers](/communication-and-collaboration/subscribers)
92+
- [Notifications](/communication-and-collaboration/notifications)

‎docs/communication-and-collaboration/notifications.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Notifications
3+
description: Understand what triggers notifications in Plane, how in-app, email, and push notifications work, how to set your notification preferences, and how stacked emails reduce inbox noise.
4+
---
5+
6+
# Notifications
7+
8+
Notifications are how Plane tells you something changed on a work item you care about. Every time a tracked change happens, Plane builds a list of people who should know — subscribers, assignees, and the creator — and sends them a notification.
9+
10+
There are three channels: in-app inbox, email, and push (mobile). You can control which events send you emails.
11+
12+
## Set your notification preferences
13+
14+
You can control which types of changes send you email notifications — you don't have to receive emails for everything.
15+
16+
1. Go to **Profile Settings → Notifications**.
17+
2. Toggle on or off:
18+
- **Property changes** — assignee, label, priority, due date, and other field changes
19+
- **State changes** — when a work item moves to a different state
20+
- **Issue completed** — specifically when a work item reaches a completed state (sub-toggle under state changes)
21+
- **Comments** — new or updated comments
22+
- **Mentions** — when someone @-mentions you
23+
24+
These preferences apply across your whole workspace — there's no per-project setting. Changes save immediately.
25+
26+
Inbox notifications always come through regardless of these settings. These toggles only affect emails.
27+
28+
## Events that trigger notifications
29+
30+
| Event | Notifies? |
31+
| ----------------------------------------------------------------- | -------------------------------------------------------------------- |
32+
| Work item created | Yes |
33+
| Any field updated (state, priority, assignee, label, dates, etc.) | Yes |
34+
| Comment added | Yes |
35+
| Comment edited | Yes |
36+
| Comment deleted | Yes |
37+
| Link added, updated, or removed | Yes |
38+
| Attachment added or removed | Yes |
39+
| Work item relation added or removed (blocked by, duplicate, etc.) | Yes |
40+
| Work item deleted | Yes |
41+
| @mention in description or comment | Yes (mention notification) |
42+
| Epic field updated | Yes |
43+
| Epic update published (progress or status post) | Yes — all epic subscribers get an email |
44+
| Due date approaching (reminder) | Yes — subscribers and assignees get an in-app and email notification |
45+
46+
## Notification channels
47+
48+
| Channel | When it fires | Can be turned off? |
49+
| ------------- | --------------------------------------- | --------------------------------- |
50+
| Inbox | Every tracked event | No |
51+
| Email | Tracked events, batched every 5 minutes | Yes, via notification preferences |
52+
| Push (mobile) | Every tracked event | Yes |
53+
54+
Emails are batched — they don't go out the instant something changes. Plane groups pending email notifications and sends them every 5 minutes.
55+
56+
## Batched email notifications
57+
58+
Plane doesn't send one email per change. Multiple changes to the same work item are grouped into a single email, sent every 5 minutes. If someone updates the priority, changes the state, and adds a comment in quick succession, you get one email covering all three — not three separate ones.
59+
60+
This means there's always a short delay before an email arrives, but it also means your email inbox doesn't fill up when a work item goes through a burst of activity.
61+
62+
## Who gets notified
63+
64+
For each change, Plane notifies:
65+
66+
- Everyone subscribed to the work item
67+
- All current assignees
68+
- The person who created the work item
69+
70+
The person who made the change is excluded — you don't get notified about your own actions.
71+
72+
If someone is @-mentioned in the same activity, they get a mention notification specifically, not an additional subscriber notification.
73+
74+
## Notification preferences
75+
76+
These settings live in **Profile Settings → Notifications** and apply globally across all your projects.
77+
78+
| Preference | What it controls |
79+
| ---------------- | ------------------------------------------------------------------------------------------------ |
80+
| Property changes | Emails for any field update (assignee, label, priority, dates, etc.) |
81+
| State changes | Emails when a work item moves to a different state |
82+
| Issue completed | Emails specifically when a work item reaches a completed state (sub-setting under state changes) |
83+
| Comments | Emails for new or updated comments |
84+
| Mentions | Emails when you are @-mentioned |
85+
86+
Turning off a preference stops the email — it does not stop the in-app notification.
87+
88+
## The difference between inbox and email notifications
89+
90+
In-app notifications always come through — your notification preferences don't affect them. They accumulate in the Inbox panel and you can read, snooze, or archive them from there.
91+
92+
Email notifications are the ones you can control. Your preferences in Profile Settings let you decide which types of changes are worth an email. If you want in-app pings for everything but only emails for comments and mentions, you can set that up.
93+
94+
## Due date reminders
95+
96+
Due date reminders are a special notification type configured at the project level (in Project Settings → Automations). When enabled, Plane sends a notification to both the work item's subscribers and its assignees when the due date is within the configured window — say, 3 days out.
97+
98+
These are one-time per window. If you've set a 3-day reminder and someone already received it, they won't get another one until the window resets. Reminders only go out for work items that are still in progress — completed and cancelled items are skipped. See [Set up due date reminders](/automations/overview#set-up-due-date-reminders).
99+
100+
## See also
101+
102+
- [Subscribers](/communication-and-collaboration/subscribers)
103+
- [Inbox](/communication-and-collaboration/inbox)

‎docs/communication-and-collaboration/subscribers.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Subscribers
3+
description: Learn how to subscribe to work items and epics in Plane, manage subscriber lists, set up project-level auto-subscriptions, and understand how Plane subscribes you automatically.
4+
---
5+
6+
# Subscribers
7+
8+
A subscription is how you tell Plane to keep you in the loop on a work item or epic. When you're subscribed, you get notified whenever something changes — a state update, a new comment, a priority shift, an assignee change.
9+
10+
You don't always have to subscribe manually. Plane adds you automatically in a few situations: when you're assigned to something, when someone @-mentions you, or when an admin has set you up as a project-level subscriber. Everything else is opt-in.
11+
12+
## Subscribe to a work item
13+
14+
Open any work item and look for the **Subscribe** button — you'll find it in the detail panel on the right side, or in the peek view. Click it once and you're subscribed. The button switches to **Unsubscribe** to confirm.
15+
16+
From that point on, you'll get in-app and email notifications whenever someone makes a change to that work item.
17+
18+
## Unsubscribe from a work item
19+
20+
Open the work item and click **Unsubscribe**. That's it — you'll stop receiving notifications for it immediately.
21+
22+
If you were auto-subscribed (because you were assigned, for example), unsubscribing works the same way. Being removed as an assignee doesn't automatically unsubscribe you — you have to do that yourself if you want to stop getting notifications.
23+
24+
## Subscribe to an epic <Badge type="info" text="Pro" />
25+
26+
Epics have their own subscribe flow, separate from work items.
27+
28+
Open an epic and click the **Subscribe** button in the detail panel. You'll get notified when the epic itself changes — field updates, state changes, comments, and when an epic update (a progress or status post) is published.
29+
30+
Epics work the same way as work items for most notifications. The one thing that's different is **epic updates**. When someone publishes a progress or status update on an epic, Plane sends an email specifically to all epic subscribers. This is separate from the usual change notifications — it's more like a broadcast, letting stakeholders know about deliberate progress posts rather than individual field edits.
31+
32+
If you're subscribed to an epic, you get both: notifications for changes to the epic itself, and emails when an epic update is published.
33+
34+
To unsubscribe, click **Unsubscribe** from the same panel.
35+
36+
## Subscribe to multiple work items at once <Badge type="info" text="Pro" />
37+
38+
If you need to subscribe to several work items in one go:
39+
40+
1. Select the work items you want from a project list view.
41+
2. In the bulk operations toolbar that appears, click the bell icon.
42+
3. Click **Subscribe** in the modal and you'll be subscribed to all selected items.
43+
44+
This subscribes you, specifically. It doesn't change anyone else's subscriptions.
45+
46+
## Set up project-level subscribers <Badge type="warning" text="Enterprise Grid" />
47+
48+
> Role: Project Admin
49+
50+
Project subscribers are members who are automatically subscribed to every work item in a project — both existing ones and any new ones created going forward.
51+
52+
1. Go to **Project Settings → Members**.
53+
2. Find the **Project subscribers** section.
54+
3. Add the members you want to auto-subscribe.
55+
56+
When you add someone as a project subscriber, Plane subscribes them to all current work items in the project in the background. They'll also be subscribed automatically to any new work items created afterward.
57+
58+
The trade-off is volume. Project subscribers get notifications for every tracked change on every work item in the project. If a project is active, that adds up quickly. Notification preferences help here — you can reduce the email noise without losing in-app visibility.
59+
60+
## Manage who's subscribed to a work item <Badge type="warning" text="Enterprise Grid" />
61+
62+
You can see and edit the subscriber list directly from a work item.
63+
64+
1. Open the work item.
65+
2. Next to the Subscribe button, you'll see a member selector showing current subscribers.
66+
3. Add or remove members as needed.
67+
68+
Only workspace members can be added as subscribers. You need edit permission on the work item to make changes here.
69+
70+
## View all work items you're subscribed to
71+
72+
You can see every work item you're currently subscribed to. Go to the [Your Work](/your-work) page and look for the **Subscribed** tab. It shows all work items across all projects where you're an active subscriber.
73+
74+
## How you get auto-subscribed
75+
76+
| Situation | Subscribed automatically? |
77+
| ------------------------------------------- | --------------------------------------------- |
78+
| You are assigned to a work item | Yes |
79+
| You @-mention someone (they get subscribed) | Yes, the mentioned person |
80+
| You create a work item | No — but you're still notified as the creator |
81+
| You comment on a work item | Yes |
82+
| You are a project subscriber | Yes, to all work items in the project |
83+
84+
## See also
85+
86+
- [Notifications](/communication-and-collaboration/notifications)
87+
- [Inbox](/communication-and-collaboration/inbox)

‎docs/core-concepts/account/settings.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Adds animation to cursor movement for a more fluid experience when navigating th
9292

9393
## Notifications
9494

95-
Control email notification preferences for work item updates. Email notifications supplement in-app notifications visible in the [Inbox](/core-concepts/inbox) section.
95+
Control email notification preferences for work item updates. Email notifications supplement in-app notifications visible in the [Inbox](/communication-and-collaboration/inbox) section.
9696

9797
All notifications apply only to work items where you are the creator, assigned to, or explicitly subscribed.
9898

0 commit comments

Comments
 (0)