convex-notification

Implements typed in-app notification storage, querying, and delivery for Convex applications.

Updated Jun 7, 2026
One-click install
npx skills add https://github.com/agnivon/viral_thread_generator --skill convex-notification-agnivon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-notification
Source: https://github.com/agnivon/viral_thread_generator/tree/main/.agents/skills/convex-notification
Command: npx skills add https://github.com/agnivon/viral_thread_generator --skill convex-notification-agnivon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex-notification.

What problem does it solve? Building an in-app notification system from scratch requires designing schemas, pagination, read-state tracking, and deduplication logic. This Skill provides a ready-made Convex component that handles typed notification storage, querying, and delivery so you can ship notification feeds without writing the infrastructure yourself. ## Core Features & Use Cases - Typed Notification Kinds: Register payload schemas with Convex validators so every notification's data object is type-checked against its kind. - Feed & State Management: Built-in functions for listing, paginating, counting unseen notifications, marking seen, and dismissing items. - Deduplication & Batching: Create notifications with dedupe keys and configurable batch chunk sizes for paginated queries. - Use Case: A team collaboration app needs to notify users about invites and admin broadcasts. Register team_invite and admin_broadcast kinds, expose the generated API with your auth resolver, and create notifications from backend mutations with a single typed call. ## Quick Start Ask the AI to install the convex-notification npm package and set up a typed notification feed in your Convex app following the skill's configuration steps.

Frequently Asked Questions about convex-notification

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add in-app notifications to a Convex app?▼

Install the convex-notification npm package, register it in convex.config.ts with app.use(notification), define your notification kinds with validators, and expose the generated API functions like list, unseenCount, and markSeen through your own auth resolver.

How do I create typed notifications in Convex?▼

Define kinds in defineNotifications using Convex validators such as v.object with title, body, and href fields. Then call notifications.create with a targetId, kind, and data object, which is type-checked against your registered kind configuration.

Does convex-notification support pagination and unread counts?▼

Yes. The generated API includes listPage for paginated queries with a configurable batchChunkSize, plus counts and unseenCount functions. The defaultListLimit option controls results when querying without pagination.

Can I prevent duplicate notifications in Convex?▼

Yes. Pass a dedupeKey when calling notifications.create, such as "invite:abc123", so repeated creation attempts for the same logical event do not produce duplicate notifications for the user.

When should I not use the convex-notification component?▼

Avoid it when a simpler built-in solution covers your use case, when your backend is not Convex, or when you do not need notification functionality at all. It is purpose-built for Convex applications only.