novu

# Cloud (quickest)
# Sign up at https://web.novu.co and get your API key

# Self-hosted with Docker
git clone https://github.com/novuhq/novu.git
cd novu
docker compose up -d

# Install SDK
npm install @novu/node        # Server SDK
npm install @novu/react       # React notification center

// Providers are configured in the Novu dashboard or via API
// Each channel type (email, SMS, push) can have multiple providers

// Example: Configure SendGrid for email, Twilio for SMS
import { Novu } from '@novu/node'

const novu = new Novu(process.env.NOVU_API_KEY)

// Providers are typically configured via the dashboard UI:
// Email: SendGrid, Mailgun, Amazon SES, Postmark, Resend
// SMS: Twilio, Vonage, Plivo, MessageBird
// Push: FCM, APNs, Expo, OneSignal
// Chat: Slack, Discord, Microsoft Teams

// workflows/welcome.ts — Define a multi-channel notification workflow
// Novu Framework (code-first approach)
import { workflow } from '@novu/framework'

export const welcomeWorkflow = workflow('welcome-onboarding', async ({ step, payload }) => {
  // Step 1: Send in-app notification immediately
  await step.inApp('welcome-inbox', async () => ({
    subject: `Welcome, ${payload.name}! 🎉`,
    body: 'Check out our getting started guide to make the most of your account.',
    avatar: 'https://example.com/logo.png',
    redirect: { url: '/getting-started' },
  }))

  // Step 2: Send email
  await step.email('welcome-email', async () => ({
    subject: `Welcome to Our Platform, ${payload.name}!`,
    body: `
      <h1>Welcome aboard!</h1>
      <p>Hi ${payload.name}, thanks for signing up.</p>
      <p>Here are 3 things to try first:</p>
      <ol>
        <li>Complete your profile</li>
        <li>Create your first project</li>
        <li>Invite your team</li>
      </ol>
      <a href="https://app.example.com/getting-started">Get Started →</a>
    `,
  }))

  // Step 3: Wait 3 days, then send SMS if they haven't been active
  await step.delay('wait-for-activation', { amount: 3, unit: 'days' })

  await step.sms('activation-reminder', async () => ({
    body: `Hi ${payload.name}! Your account is ready. Log in to get started: https://app.example.com`,
  }))
}, {
  payloadSchema: {
    type: 'object',
    properties: {
      name: { type: 'string' },
      email: { type: 'string' },
    },
    required: ['name', 'email'],
  },
})

// lib/notifications.ts — Trigger notification workflows
import { Novu } from '@novu/node'

const novu = new Novu(process.env.NOVU_API_KEY)

// Trigger welcome workflow for a new user
export async function notifyNewUser(user) {
  await novu.trigger('welcome-onboarding', {
    to: {
      subscriberId: user.id,
      email: user.email,
      phone: user.phone,
      firstName: user.name,
    },
    payload: {
      name: user.name,
      email: user.email,
    },
  })
}

// Trigger for multiple subscribers (batch)
export async function notifyTeam(teamMemberIds, message) {
  await novu.bulkTrigger(teamMemberIds.map(id => ({
    name: 'team-notification',
    to: { subscriberId: id },
    payload: { message },
  })))
}

// Override channel for specific trigger
export async function sendUrgentAlert(userId, message) {
  await novu.trigger('urgent-alert', {
    to: { subscriberId: userId },
    payload: { message },
    overrides: {
      sms: { content: `URGENT: ${message}` },
    },
  })
}

// components/NotificationBell.tsx — Drop-in notification center
import { Inbox } from '@novu/react'

export function NotificationBell() {
  return (
    <Inbox
      applicationIdentifier={process.env.NEXT_PUBLIC_NOVU_APP_ID!}
      subscriberId={currentUser.id}
      appearance={{
        elements: {
          bellContainer: { width: '40px', height: '40px' },
        },
      }}
      onNotificationClick={(notification) => {
        if (notification.redirect?.url) {
          window.location.href = notification.redirect.url
        }
      }}
    />
  )
}

// Subscribers can control which channels they receive notifications on
// This is built into Novu's notification center UI

// Programmatically update preferences
await novu.subscribers.updatePreference(subscriberId, templateId, {
  channel: { type: 'email', enabled: false },    // user opts out of email
})

// Get subscriber preferences
const prefs = await novu.subscribers.getPreference(subscriberId)