DOCSEARCHbyAlgolia
Submit Docs

Novu Documentation

website·Indexed 36 days ago

https://docs.novu.co

Documentation for Novu's notification infrastructure, covering dashboard workflows, @novu/framework integration, and workflow design. Includes guides on step types (Email, SMS, Push, In-App, Chat, HTTP Request), workflow primitives like Delay, Digest, and Throttle steps, and technical setup for Bridge Endpoints, schema validation with Zod, and GitOps deployment.

Tokens
349.8K
Snippets
1.3K
Records
2.4K
Agent score
67%

What's inside Novu

  1. Overview of Novu Notification Workflows

    Novu Workflows allow developers to orchestrate multi-channel notifications (Email, SMS, Push, In-app, and Chat) by combining delivery logic, message content, and execution rules into a single pipeline. This centralizes notification logic, removing the need to hardcode delivery behavior within the application code. Key capabilities include controlling delivery timing via delays, batching, and throttling, as well as personalizing content using event data and LiquidJS templates.

  2. Overview of Novu Polling Endpoints

    A polling endpoint allows a worker to fetch Novu webhook events by making authenticated HTTPS requests, eliminating the need to expose a public HTTP receiver. Each consumer (identified by a unique Consumer ID) tracks its own progress through the event stream independently.

  3. Overview of Novu Workflow Steps

    Workflow steps are the building blocks of a Novu notification workflow. They are executed linearly from top to bottom. Each step operates independently; if one step fails, other steps in the workflow can still succeed. Steps are managed via the workflow editor in the Novu dashboard. Custom steps can be created using the Novu Framework.

  4. Overview of Novu Headless Subscription Hooks

    Novu provides headless hooks via the @novu/react, @novu/nextjs, and @novu/react-native packages. These hooks allow developers to build fully custom subscription and preference management interfaces by exposing data, mutations, and state management without providing a pre-built UI.

  5. Overview of Amazon SNS Webhook Connector

    The Amazon SNS connector allows Novu to publish selected webhook events to an AWS SNS topic. This enables fanning out a single Novu event to multiple subscribers simultaneously, such as SQS queues, Lambda functions, or HTTP subscribers. Novu delivers events in batches, but each event within a batch is published to the SNS topic as a separate message. Outbound webhooks are available on Team and Enterprise plans.

  6. Overview of Novu Dashboard migration strategy

    Migrating from the legacy Novu Dashboard to the new Dashboard involves creating new workflows rather than converting existing ones in place. Because legacy and new workflows use different IDs, they can run side-by-side in the same environment. This allows for a zero-downtime migration where legacy workflows continue to serve traffic until the application is updated to trigger the new workflow IDs.

    Key Migration Goals:

    • Ensure every production legacy workflow has a corresponding new workflow.
    • Maintain equivalent content delivery across channels and providers.
    • Preserve step order, conditions, delays, digests, and subscriber preferences.
    • Transition application triggers to new workflow IDs.
    • Update in-app notifications to use the current Inbox SDK.

  7. Overview of Novu Topics

    A topic in Novu is a way to group subscribers under a shared label (a topicKey). This allows developers to broadcast messages to many users with a single workflow trigger, removing the need to manage individual subscriber IDs for scenarios like product announcements, feature rollouts, or status updates. Topics support up to 100,000 subscribers each. When a workflow is triggered to a topic, Novu creates a separate workflow event for every matching subscriber.

  8. Overview of Novu Connect Agent Communication Infrastructure (ACI)

    Novu Connect uses the Agent Communication Infrastructure (ACI) to decouple communication infrastructure from agent intelligence. This allows a single AI agent to operate across multiple channels (Slack, Microsoft Teams, WhatsApp, Telegram, email, and in-app Web Chat) without needing to build separate integrations for each.

    ACI manages the following communication layer responsibilities:

    • Webhook ingestion and message normalization
    • Conversation state and history maintenance
    • Identity resolution
    • Message delivery

    The developer is responsible for the 'Agent Intelligence' layer, which includes the LLM, prompts, tools, business logic, and custom runtime.

  9. Overview of Novu Framework for Code-First Workflows

    The Novu Framework allows developers to build, version, and deploy notification workflows entirely in TypeScript. By running a portion of the Novu workflow engine within their own network boundary, developers can inject custom code into workflows, maintain workflows in source control alongside application code, and hydrate notification content using local data sources without syncing sensitive data outside their IT boundary.

  10. Overview of Novu Headless Mode

    Headless Mode allows developers to build fully custom in-app notification UIs by using React hooks that provide data, actions, and state without the constraints of prebuilt components like the <Inbox /> UI. The @novu/react package provides these hooks, while the developer handles layout, styling, and interactions.

  11. Overview of Novu MCP Server

    The Novu MCP Server implements the Model Context Protocol (MCP) to expose Novu's notification and agent infrastructure as tools for AI assistants. This allows developers to manage subscribers, workflows, integrations, agents, and delivery activity via natural-language prompts. It is distinct from the Novu documentation MCP server, which is read-only and used for searching documentation.

  12. Overview of the Novu Notification Platform

    Novu is a multi-channel notification platform that allows developers to build, manage, and deliver notifications. It provides a stack that includes a code-first notification framework for workflow management, a JSON schema-based system for no-code visual editing, and prebuilt UI components for in-app notification feeds and user preference centers. The platform supports high-volume delivery via Novu Cloud SaaS or self-hosted open-source deployments, offering observability into the notification lifecycle and integration with over 60 delivery providers.