SvelteKit

In this guide, we will add a Novu Bridge Endpoint to a Svelte application and send our first test workflow.

Set up your local environment

Start local development by running:

npx novu dev

This opens the Novu Dashboard in Local mode — a local environment connected to your running app through a tunnel — where you can preview and test the workflows running on your machine. See Local development for details.

Install packages

Install the Novu Framework package:

npm install @novu/framework

This package provides all the necessary tools to build and manage your notification workflows.

Add a Novu API Endpoint

src/routes/api/novu/+server.ts


export const { GET, POST, OPTIONS } = serve({ workflows: [testWorkflow] });

Configure your secret key

Add your Novu secret key to your environment variables:

.env

NOVU_SECRET_KEY=your_secret_key

Create your workflow definition

Add a novu folder in your lib folder as such src/lib/novu/workflows.ts that will contain your workflow definitions.

app/novu/workflows.ts

import { workflow } from '@novu/framework';

export const testWorkflow = workflow('test-workflow', async ({ step }) => {
  await step.email('test-email', async () => {
    return {
      subject: 'Test Email',
      body: 'This is a test email from Novu Framework!',
    };
  });
});

Start your application

To start your Svelte server with the Novu Endpoint configured, run the following command:

cd my-novu-app && npm run dev

Svelte application default port is 5173. For that to work, restart npx novu dev and point it to the right port:

npx novu@latest dev --port <YOUR_SVELTE_APPLICATION_PORT>

Test your endpoint

Test your workflow by triggering it from the Local environment or using the Novu API:

curl -X POST https://api.novu.co/v1/events/trigger \
  -H 'Authorization: ApiKey YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "my-workflow",
    "to": "subscriber-id",
    "payload": {}
  }'

You should see the notification being processed in the Local environment.

Deploy your application

Deploy your application to your preferred hosting provider. Make sure the /api/novu endpoint is accessible from the internet.For local development and testing, you can use tools like ngrok to expose your local server to the internet.

Now that you have your first workflow running, you can:

Learn about Workflow Controls to expose no-code editing capabilities
Explore different Channel Steps like Email, SMS, Push, and more
Set up Action Steps like Delay and Digest
Check out our React Email integration for building beautiful email templates

Getting Started

Core Concepts

Channels

Content

Advanced Features

API Reference

Deployment

Set up your local environment

Install packages

Add a Novu API Endpoint

Configure your secret key

Create your workflow definition

Start your application

Test your endpoint

Deploy your application

​Set up your local environment

​Install packages

​Add a Novu API Endpoint

​Configure your secret key

​Create your workflow definition

​Start your application

​Test your endpoint

​Deploy your application

Set up your local environment

Install packages

Add a Novu API Endpoint

Configure your secret key

Create your workflow definition

Start your application

Test your endpoint

Deploy your application