# Novu: Resources

> The open-source notification infrastructure for agents and products. Send, receive, and track notifications across channels.

## Resources

### Guides

#### Guides

- [Novu Integration Guides and Recipes](https://docs.novu.co/guides.md): Step-by-step Novu integration guides for Clerk, Stripe, Segment, Hightouch, Databricks, Auth0, Supabase, and other services to add notifications to your product stack.

##### Use Cases

- [Transactional Notifications with Novu](https://docs.novu.co/guides/use-cases/transactional-notifications.md): Send transactional notifications for orders, payments, shipments, and account events using Novu workflows, the REST API, and multi-channel delivery.
- [Password Reset and Auth Alert Notifications](https://docs.novu.co/guides/use-cases/password-reset-notifications.md): Build password reset, email verification, and authentication alert workflows with Novu using email and in-app channels, subscribers, and secure token payloads.
- [Digest and Batched Notifications](https://docs.novu.co/guides/use-cases/digest-notifications.md): Batch and summarize notifications with Novu digest steps. Send digests like "10 new comments" instead of individual alerts, with configurable windows and keys.
- [Multi-Channel Notification Fallback Workflows](https://docs.novu.co/guides/use-cases/multi-channel-fallback.md): Build multi-channel notification workflows with delays and fallbacks in Novu. Send in-app first, then follow up with email or SMS when notifications go unread.
- [User Notification Preferences with Novu](https://docs.novu.co/guides/use-cases/notification-preferences.md): Let subscribers manage notification preferences per workflow and channel using the Novu Inbox component and the preferences API for user-facing settings.

##### Workflow automation

- [Inngest](https://docs.novu.co/guides/inngest.md): Integrate Inngest with Novu to trigger notification workflows from background jobs and durable functions. Covers setup, event sending, and best practices.
- [Trigger.dev](https://docs.novu.co/guides/triggerdotdev.md): Integrate Novu with Trigger.dev to send notifications from background jobs and scheduled tasks. Covers setup, subscriber sync, and practical workflow examples.

##### Incoming webhooks

- [Clerk](https://docs.novu.co/guides/webhooks/clerk.md): Integrate Clerk webhooks with Novu notifications in a Next.js app. Trigger workflows on signups, session events, and organization membership changes.
- [Auth0 Webhook Integration with Novu](https://docs.novu.co/guides/webhooks/auth0.md): Trigger Novu notification workflows from Auth0 events such as password reset, signup, and login alerts by forwarding webhooks to your Novu workflows.
- [Stripe](https://docs.novu.co/guides/webhooks/stripe.md): Integrate Stripe subscription webhooks with Novu in a Next.js app. Trigger workflows when subscriptions are created or updated.

##### Webhook connectors

###### Data warehouses

- [Export notification events to a data warehouse](https://docs.novu.co/guides/webhook-connectors/data-warehouse-sync.md): Stream Novu delivery and engagement events to BigQuery or another data warehouse for notification analytics.
- [Insert webhook events into ClickHouse](https://docs.novu.co/guides/webhook-connectors/clickhouse.md): Insert Novu webhook events into a ClickHouse table with the ClickHouse connector, including table setup, JSONEachRow column matching, and a batch transformation.
- [Stream webhook events into Google BigQuery](https://docs.novu.co/guides/webhook-connectors/google-bigquery.md): Stream Novu webhook events into a BigQuery table with the BigQuery connector, including service account permissions, the default id and payload schema, and a batch transformation.
- [Load webhook events into Snowflake](https://docs.novu.co/guides/webhook-connectors/snowflake.md): Load Novu webhook events into a Snowflake table with the Snowflake connector, including key-pair authentication, the default three column schema, and column-oriented bindings.
- [Load webhook events into Amazon Redshift](https://docs.novu.co/guides/webhook-connectors/amazon-redshift.md): Write Novu webhook events to an Amazon Redshift table with the Redshift connector, covering Serverless and provisioned clusters, the Redshift Data API, and named SQL bindings.
- [Insert webhook events into Postgres](https://docs.novu.co/guides/webhook-connectors/postgres.md): Insert Novu webhook events into a Postgres table with the Postgres connector, including least-privilege database grants, an analytics schema, and verification from the Novu Dashboard.

###### Object storage

- [Store webhook events in Amazon S3](https://docs.novu.co/guides/webhook-connectors/amazon-s3.md): Configure the Amazon S3 webhook connector to archive batched Novu events as objects, including the transformation contract, object key behavior, and verification steps.
- [Send webhook events to Azure Blob Storage](https://docs.novu.co/guides/webhook-connectors/azure-blob-storage.md): Configure the Azure Blob Storage webhook connector to store selected Novu events as batched blobs.
- [Send webhook events to Google Cloud Storage](https://docs.novu.co/guides/webhook-connectors/google-cloud-storage.md): Configure the Google Cloud Storage webhook connector to store selected Novu events as batched objects.

###### Messaging

- [Send webhook events to Amazon SQS](https://docs.novu.co/guides/webhook-connectors/amazon-sqs.md): Configure the Amazon SQS webhook connector to deliver Novu events as queue messages, including the batch transformation contract, message body control, and verification steps.
- [Publish webhook events to Amazon SNS](https://docs.novu.co/guides/webhook-connectors/amazon-sns.md): Configure the Amazon SNS webhook connector to publish Novu events to a topic, including the batch transformation contract, message subject support, and verification steps.
- [Send webhook events to Amazon EventBridge](https://docs.novu.co/guides/webhook-connectors/amazon-eventbridge.md): Configure the Amazon EventBridge webhook connector to publish Novu events to an event bus, including the batch transformation contract, detail type behavior, and rule matching.
- [Publish webhook events to RabbitMQ](https://docs.novu.co/guides/webhook-connectors/rabbitmq.md): Configure the RabbitMQ webhook connector to publish selected Novu events as individual AMQP messages.
- [Publish webhook events to Google Cloud Pub/Sub](https://docs.novu.co/guides/webhook-connectors/google-cloud-pubsub.md): Configure the Google Cloud Pub/Sub webhook connector and verify selected Novu events in a subscription.

###### Analytics & observability

- [Send webhook events to Segment](https://docs.novu.co/guides/webhook-connectors/segment.md): Configure the Segment webhook connector to map selected Novu events to Segment Track calls.
- [Send webhook events to an OpenTelemetry Collector](https://docs.novu.co/guides/webhook-connectors/opentelemetry-collector.md): Configure the OpenTelemetry Collector webhook connector to convert selected Novu events into OTLP trace spans.

###### HTTP delivery

- [Consume webhook events from a polling endpoint](https://docs.novu.co/guides/webhook-connectors/polling-endpoint.md): Create a Novu polling endpoint, fetch selected webhook events by consumer ID, and commit processed offsets.
- [Receive webhook events in FIFO order](https://docs.novu.co/guides/webhook-connectors/fifo-endpoint.md): Configure a FIFO webhook endpoint to receive selected Novu events in ordered HTTP batches.

##### Data sources

- [Segment](https://docs.novu.co/guides/analytics/segment.md): Learn how to set up Segment as a data source for Novu using Destination Functions. Send user events from Segment to trigger notifications in Novu.
- [Hightouch](https://docs.novu.co/guides/analytics/hightouch.md): Learn how to set up Hightouch as a data source for Novu using the HTTP Request destination. Sync warehouse data to create subscribers and trigger notification workflows in Novu.
- [Databricks](https://docs.novu.co/guides/analytics/databricks.md): Sync subscriber profiles, cohort membership, and workflow events from Databricks to Novu with the REST API. Includes incremental processing, retries, and rate-limit handling.

##### Recipes

- [Managing Workflows](https://docs.novu.co/guides/recipes/managing-workflows.md): Update workflow definitions in the Novu Development environment through the API, then publish them to Staging and Production through CI/CD pipelines.
- [Supabase Auth Notifications with Novu](https://docs.novu.co/guides/recipes/supabase-auth-notifications.md): Send signup, password reset, and authentication alert notifications from Supabase Auth events using Novu workflows, subscribers, and multi-channel delivery.

##### Framework

- [Using Translations](https://docs.novu.co/guides/framework/using-translations.md): Translate Novu Framework workflow step content into multiple languages with translation keys, locales, and per-subscriber locale resolution.

##### Migrate to Novu

- [Migrate from Courier to Novu](https://docs.novu.co/guides/migrate-from-courier-to-novu.md): Migrate your notification infrastructure from Courier to Novu step by step. Map templates and profiles to Novu workflows and subscribers with minimal downtime.
- [Migrate from Knock to Novu](https://docs.novu.co/guides/migrate-from-knock-to-novu.md): Plan and execute a migration from Knock to Novu. Map concepts side by side, migrate workflows, subscribers, in-app feeds, and preferences without downtime.
- [Migrate from MagicBell to Novu](https://docs.novu.co/guides/migrate-from-magicbell-to-novu.md): Plan and execute a migration from MagicBell to Novu. Map in-app feeds, notification workflows, and per-user preferences to their Novu equivalents step by step.
- [Migrate from In-House Notifications to Novu](https://docs.novu.co/guides/migrate-from-in-house-to-novu.md): Replace a custom-built notification system with Novu. Reduce maintenance, add multi-channel delivery, and ship an in-app Inbox faster than building it yourself.

### Framework

#### Getting Started

- [Novu Framework - Code-First Notification Workflows](https://docs.novu.co/framework.md): Build, version, and deploy notification workflows in TypeScript with the Novu Framework. Define steps in code and sync to Novu Cloud.
- [Introduction](https://docs.novu.co/framework/introduction.md): Discover how the Novu Framework empowers you to build, customize, and manage advanced notification workflows with a mix of code and no-code capabilities.

##### Quickstart

- [Next.js](https://docs.novu.co/framework/quickstart/nextjs.md): Get started with Novu Framework in a Next.js application by scaffolding an API route, defining a workflow, and triggering your first notification.
- [Express](https://docs.novu.co/framework/quickstart/express.md): Get started with Novu Framework in an Express application by scaffolding a bridge, defining a workflow, and triggering your first notification.
- [Remix](https://docs.novu.co/framework/quickstart/remix.md): Get started with Novu Framework in a Remix application by scaffolding a bridge route, defining a workflow, and triggering your first notification.
- [NestJS](https://docs.novu.co/framework/quickstart/nestjs.md): Get started with Novu Framework in a NestJS application by scaffolding a bridge module, defining a workflow, and triggering your first notification.
- [SvelteKit](https://docs.novu.co/framework/quickstart/svelte.md): Get started with Novu Framework in a SvelteKit application by scaffolding an endpoint, defining a workflow, and triggering your first notification.
- [Nuxt quickstart for Novu Framework](https://docs.novu.co/framework/quickstart/nuxt.md): Install Novu Framework in a Nuxt app, add the bridge endpoint with the serve helper, and sync your first code-based notification workflow.
- [H3](https://docs.novu.co/framework/quickstart/h3.md): Get started with Novu Framework in an H3 application by scaffolding a bridge, defining a workflow, and triggering your first notification.
- [Hono](https://docs.novu.co/framework/quickstart/hono.md): Get started with Novu Framework in a Hono application by scaffolding a bridge, defining a workflow, and triggering your first notification.
- [AWS Lambda](https://docs.novu.co/framework/quickstart/lambda.md): Get started with Novu Framework in an AWS Lambda function by scaffolding a bridge handler, defining a workflow, and triggering notifications.

#### Core Concepts

- [Local development](https://docs.novu.co/framework/studio.md): Run npx novu dev to open the Novu Dashboard in Local mode, preview workflows running on your machine, and learn how to sync them to Development and Production.
- [Bridge Endpoint](https://docs.novu.co/framework/endpoint.md): Learn how to configure the Novu Bridge Endpoint, the single HTTP endpoint your application exposes to communicate with the Novu Worker Engine.
- [Tags](https://docs.novu.co/framework/tags.md): Implement and manage notification tags programmatically in Novu Framework to categorize workflows and control subscriber preferences in the Inbox.
- [Payload](https://docs.novu.co/framework/payload.md): Define and validate workflow payload schemas in Novu Framework with Zod or JSON Schema to ensure type safety on data passed to novu.trigger.
- [Controls](https://docs.novu.co/framework/controls.md): Use Controls in Novu Framework workflows to expose configurable options to non-developers, validated by Zod or JSON Schema at runtime.

#### Channels

- [Email](https://docs.novu.co/framework/email-channel.md): Configure the email channel in Novu Framework to send transactional and marketing notifications through your preferred email provider.
- [In-App](https://docs.novu.co/framework/in-app-channel.md): Configure the in-app channel in Novu Framework to send notifications to your web or mobile inbox powered by the Novu Inbox component.
- [Push](https://docs.novu.co/framework/push-channel.md): Configure the push channel in Novu Framework to send mobile and web push notifications through providers like FCM, APNs, and OneSignal.
- [SMS](https://docs.novu.co/framework/sms-channel.md): Configure the SMS channel in Novu Framework to send text message notifications through providers like Twilio, Vonage, MessageBird, and Plivo.
- [Chat](https://docs.novu.co/framework/chat-channel.md): Configure Novu chat providers to send workflow notifications to Slack, Discord, Microsoft Teams, and WhatsApp using the Framework SDK.
- [Tool](https://docs.novu.co/framework/tool-channel.md): Use the Tool channel in Novu Framework to page on-call, open incidents, or POST JSON to a webhook from a workflow step.

#### Content

- [React Email](https://docs.novu.co/framework/content/react-email.md): Design beautiful, responsive email templates for Novu workflows with React Email components and render them from your Framework email step.
- [Remix & React Email](https://docs.novu.co/framework/content/remix-react-email.md): Integrate React Email templates with Novu Framework in a Remix application to render rich, responsive transactional emails inside your workflows.
- [Svelte Email](https://docs.novu.co/framework/content/svelte-email.md): Use Svelte Email components with the Novu Framework to build responsive, reusable transactional email templates in your Svelte or SvelteKit project.
- [Vue Email](https://docs.novu.co/framework/content/vue-email.md): Design responsive email templates for Novu workflows with Vue Email components and render them from your Framework email step at trigger time.

#### Advanced Features

- [Digest Action](https://docs.novu.co/framework/digest.md): Collect multiple workflow events into a single notification with the Novu Framework digest step, using time windows and grouping keys.
- [Delay Action](https://docs.novu.co/framework/delay.md): Pause Novu Framework workflow execution for a fixed duration or until a specific timestamp using the delay step in your notification pipelines.
- [Custom Step](https://docs.novu.co/framework/custom.md): Use the custom step in Novu Framework to run arbitrary business logic, fetch data, or integrate services as part of a workflow execution.
- [Skip Function](https://docs.novu.co/framework/skip.md): Skip individual steps of a Novu Framework workflow at runtime based on a condition function evaluated against payload, subscriber, and controls.

#### API Reference

- [Novu Framework TypeScript SDK Overview](https://docs.novu.co/framework/typescript/overview.md): Learn how to use Novu's TypeScript SDK to build type-safe notification workflows with advanced features like payload validation and step controls.
- [Client](https://docs.novu.co/framework/typescript/client.md): Configure the Novu Framework Client for global settings like API URL, secret key, strict authentication, and payload logging in your bridge app.
- [Workflow](https://docs.novu.co/framework/typescript/workflow.md): Reference the Novu Framework workflow interface: workflow IDs, payload schemas, tags, preferences, control values, and step composition.
- [Zod](https://docs.novu.co/framework/schema/zod.md): Integrate Zod with Novu Framework to define and validate workflow payload schemas and step controls with type-safe TypeScript inference.
- [JSON Schema](https://docs.novu.co/framework/schema/json-schema.md): Use JSON Schema in Novu Framework to define and validate workflow payload data and step control inputs across languages and tools.
- [Class Validator](https://docs.novu.co/framework/schema/class-validator.md): Integrate class-validator with Novu Framework to validate workflow payload and step control schemas using TypeScript class decorators.

##### Steps

- [Steps](https://docs.novu.co/framework/typescript/steps.md): Reference the Novu Framework step interface, its configuration options, and how each channel and action step is composed inside workflows.
- [Chat](https://docs.novu.co/framework/typescript/steps/chat.md): Use the chat step in Novu Framework to send plain-text or rich card messages to Slack, Discord, Microsoft Teams, and other chat providers.
- [Email](https://docs.novu.co/framework/typescript/steps/email.md): Use the email step in Novu Framework to send email notifications with dynamic subject lines, HTML bodies, and React Email templates.
- [In-App](https://docs.novu.co/framework/typescript/steps/inApp.md): Use the in-app step in Novu Framework to send notifications to your web or mobile inbox with rich content, actions, redirects, and per-user data.
- [Push](https://docs.novu.co/framework/typescript/steps/push.md): Use the push step in Novu Framework to send mobile and web push notifications through providers like FCM, APNs, OneSignal, and Expo.
- [SMS](https://docs.novu.co/framework/typescript/steps/sms.md): Use the SMS step in Novu Framework to send text messages through providers like Twilio, Vonage, and MessageBird as part of a workflow.
- [Tool](https://docs.novu.co/framework/typescript/steps/tool.md): Use the tool step in Novu Framework to deliver a payload to PagerDuty, Opsgenie, Grafana, or a Tool webhook as part of a workflow.
- [Custom](https://docs.novu.co/framework/typescript/steps/custom.md): Use the custom step in Novu Framework to execute arbitrary TypeScript code, fetch data, or call third-party APIs during workflow execution.
- [Delay](https://docs.novu.co/framework/typescript/steps/delay.md): Use the delay step in Novu Framework to pause workflow execution for a specified duration or until an absolute timestamp before resuming.
- [Digest](https://docs.novu.co/framework/typescript/steps/digest.md): Use the digest step in Novu Framework to aggregate multiple workflow events into a single notification using time windows and grouping keys.

#### Deployment

- [Production Deployment Guide](https://docs.novu.co/framework/deployment/production.md): Deploy your Novu Framework bridge to production with guidance on networking, secrets, HMAC verification, timeouts, and monitoring for reliability.
- [Syncing](https://docs.novu.co/framework/deployment/syncing.md): Sync local workflow changes to the Novu Cloud Dashboard across development and production environments using the CLI or GitHub Action.
- [Deploy workflows with the Novu CLI](https://docs.novu.co/framework/deployment/cli.md): Use the Novu CLI sync command to push Framework workflows to Novu Cloud, connect a bridge endpoint, and understand sync output messages.
- [GitHub Actions](https://docs.novu.co/framework/deployment/actions.md): Deploy Novu Framework workflows automatically from GitHub with the official Novu Sync action to keep production in sync with your repository.

### Community

#### Getting Started

- [Community Overview](https://docs.novu.co/community.md): Get started with the Novu open source project: contribute code, join the Discord, follow the roadmap, and connect with maintainers and other developers.
- [Get Involved](https://docs.novu.co/community/get-involved.md): Contribute to Novu by filing issues, opening pull requests, writing docs, joining Discord, or helping other users solve notification challenges.
- [Code of Conduct](https://docs.novu.co/community/code-of-conduct.md): Read the Novu Code of Conduct: the rules and guidelines that govern respectful interaction among contributors, maintainers, and community members.
- [Roadmap](https://docs.novu.co/community/roadmap.md): Explore Novu's public roadmap covering upcoming features, in-progress work, and how to propose ideas that shape the notification infrastructure.
- [Changelog](https://docs.novu.co/community/changelog.md): See the most recent product changes to Novu, follow release notes across the platform and SDKs, and learn how to help shape the roadmap.
- [Self-Hosted and Novu Cloud](https://docs.novu.co/community/self-hosted-and-novu-cloud.md): Compare Novu Cloud and self-hosted Novu across features, scalability, compliance, and operations to choose the right deployment model for your team.
- [Run Novu in local machine](https://docs.novu.co/community/run-in-local-machine.md): Prerequisites and steps to run Novu in local machine. Learn how to set up Novu on your local environment for testing and development.
- [Add a New Provider](https://docs.novu.co/community/add-a-new-provider.md): Contribute a new notification provider to Novu with a step-by-step guide covering package setup, the provider interface, testing, and pull requests.

##### Self Hosting Novu

- [Self-Host Novu - Open-Source Notification Infrastructure](https://docs.novu.co/community/self-hosting-novu/overview.md): Self-host Novu for full control over your notification infrastructure. Covers system requirements, VMs, Redis, MongoDB, and storage.
- [Deploy with Docker](https://docs.novu.co/community/self-hosting-novu/deploy-with-docker.md): Deploy Novu on your own infrastructure using Docker Compose, configure environment variables, and run the API, worker, and web dashboard locally.
- [Telemetry](https://docs.novu.co/community/self-hosting-novu/telemetry.md): Learn what telemetry data Novu collects from self-hosted deployments, why it is gathered, and how to disable it with an environment variable.
- [Data Migrations](https://docs.novu.co/community/self-hosting-novu/data-migrations.md): Run database data migrations for self-hosted Novu deployments to keep MongoDB and Postgres schemas in sync with the latest platform release.
- [Migrate from v0 to v2 Dashboard](https://docs.novu.co/community/self-hosting-novu/v0-to-v2-migration.md): Migrate a self-hosted Novu instance from the v0 to the v2 Dashboard with steps for data migration, feature flag changes, and workflow updates.