mcpField
N
novu

novu

github.com/novuhqDevelopment441 installsUpdated 19w ago
Repository

About novu

A skill for using Novu notification infrastructure across email, SMS, push, chat, and in-app channels. It routes common tasks to sub-skills for sending notifications, managing subscribers, integrating an inbox, and configuring preferences.

Key features

  1. 01Triggers single or bulk notifications
  2. 02Manages subscribers, topics, and groups
  3. 03Integrates in-app inbox components
  4. 04Configures notification preferences
  5. 05Routes tasks to focused sub-skills

Use cases

  1. 01Send welcome emails or trigger notification workflows
  2. 02Add an in-app notification inbox to an application
  3. 03Let subscribers configure notification preferences

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/novuhq/skills --skill novu

After installing, type/novuin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

.gitattributes
.gitignore
LICENSE
README.md
package.json
inbox-integration/references/
headless-inbox-examples.md
nextjs-inbox-examples.md
react-inbox-examples.md
security.md
manage-preferences/references/
preferences-ui-examples.md
subscriber-preferences-examples.md
workflow-preferences-examples.md
manage-subscribers/references/
credentials-examples.md
subscriber-crud-examples.md
topics-examples.md
tests/
inbox-integration.test.md
manage-preferences.test.md
manage-subscribers.test.md
novu-router.test.md
trigger-notification.test.md
trigger-notification/references/
best-practices.md
bulk-trigger-examples.md
installation.md
single-trigger-examples.md
topic-trigger-examples.md

Details

From the project README

Novu

Novu is a notification infrastructure platform for sending notifications across email, SMS, push, chat, and in-app channels. Workflows can be created via the Novu dashboard UI or in code using @novu/framework.

Sub-Skills

SkillUse When...
trigger-notificationSending notifications, triggering workflows, single or bulk sends
manage-subscribersCreating, updating, listing, or deleting subscribers; managing topics and groups
inbox-integrationAdding the in-app notification inbox, bell icon, or notification feed to a web app and react native app
manage-preferencesSetting up subscriber notification preferences, workflow defaults, or the Preferences UI

Quick Routing

  • "Send a welcome email" → trigger-notification/
  • "Create subscriber groups" → manage-subscribers/
  • "Add a bell icon to my app" → inbox-integration/
  • "Let users opt out of emails" → manage-preferences/

Common Combinations

  • Full notification system: trigger-notification/ + manage-subscribers/
  • In-app notifications: trigger-notification/ + inbox-integration/
  • Complete stack: all four skills

SDK Overview

PackageSidePurpose
@novu/apiServerTrigger notifications, manage subscribers/topics/workflows via REST
@novu/reactClientReact Inbox component, Notifications, Preferences, Bell
@novu/nextjsClientNext.js-optimized Inbox integration
@novu/react-nativeClientReact native hooks based Inbox integration
@novu/jsClientVanilla JS client for non-React apps

Important distinctions:

  • @novu/api is for triggering workflow to send notifications and managing resources (subscribers, topics, contexts)
  • @novu/react / @novu/js are for client-side Inbox integrations and preferences

Common Setup

npm i @novu/api

import { Novu } from "@novu/api";

const novu = new Novu({
 secretKey: process.env.NOVU_SECRET_KEY,
});

await novu.trigger({
  workflowId: "workflowId",
  to: "subscriberId",
  payload: {
    "comment_id": "string",
    "post": {
      "text": "string",
    },
  },
})

Resources

Comments

Markdown supported