Notification settings

This example shows how to build a user notification settings experience.

Live preview

Open the example above and share it on multiple windows or devices to try it live.

With Liveblocks Notifications, each user can choose whether they should receive notifications on different channels, for example Email, Slack, Teams. This example highlights how to create a settings panel for adjusting which notification webhooks should be triggered for the current user.

Getting started

Run the following command to try this example locally:

$npx create-liveblocks-app@latest --example nextjs-notification-settings --api-key

This will download the example and ask permission to open your browser, enabling you to automatically get your API key from your liveblocks.io account.

Before running the project, make sure to create your NextAuth secret first:

$npx auth secret

Manual setup

Alternatively, you can set up your project manually:

  • Install all dependencies with npm install
  • Create an account on liveblocks.io
  • Copy your secret key from the dashboard
  • Create an .env.local file and add your secret key as the LIVEBLOCKS_SECRET_KEY environment variable
  • Run npx auth secret to create a NextAuth secret.
  • Run npm run dev and go to http://localhost:3000

Deploy on Vercel

To both deploy on Vercel, and run the example locally, use the following command:

$npx create-liveblocks-app@latest --example nextjs-notification-settings --vercel

This will download the example and ask permission to open your browser, enabling you to deploy to Vercel.

Make sure to generate a NextAuth secret and add it to the AUTH_SECRET environment variable.

Develop on CodeSandbox

After forking this example on CodeSandbox, create the LIVEBLOCKS_SECRET_KEY environment variable as a secret.

Make sure to generate a NextAuth secret and add it to the AUTH_SECRET environment variable.

We use cookies to collect data to improve your experience on our site. Read our Privacy Policy to learn more.