Announcements Module
Free Communication Marketplace module for workspace-wide announcements with read tracking.
Guides
| Audience | Document |
|---|---|
| Operators / workspace users | announcements.md |
| Engineers | announcements.md |
| Production / ops | announcements.md |
| Module Development Standard | module-development.md |
| Tenant API | tenant-v1-announcements.md |
Capabilities
- Title + body, status (
draft/published/archived), optional expiry - After login: unread published announcements open in a dialog (Mark as read)
- Dashboard: unread announcements after the welcome greeting (hidden when none remain unread); each row has Mark as read
- History:
/announcementsfor every signed-in user (noviewpermission) - Read receipts: first/last read time + IP; admins with
view_readssee who read each announcement - Publish fans out an in-app notification (
type: announcement) - Module licensing (
module:announcements) for install; mutations use Spatie permissions
Authz (important)
There is no announcements.view permission. If the user can log in and the module is installed, they can inbox / unread / show published / mark read.
Mutations require:
announcements.create · update · delete · restore · force.delete · view_reads
Catalog
- Slug:
announcements - Category: Communication
is_default_included=false,is_billable=false, prices$0- Install from Marketplace (not auto-installed for new workspaces)
Explicitly deferred
- Role / user targeting
- Attachments / rich HTML editor
- Scheduled publish beyond draft → publish
- Central (platform-wide) announcements