Comments Emails

Getting started

Run the following command to try this example locally:

$npx create-liveblocks-app@latest --example nextjs-comments-emails-sendgrid --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.

Setting up webhooks

You need to set up webhooks to make this example run.

• Follow our guide on testing webhooks locally, making sure to check the “notification” event when creating the webhook
• Copy your webhook secret key from the webhooks dashboard
• Add your webhook secret key to .env.local as the LIVEBLOCKS_WEBHOOK_SECRET_KEY environment variable

Setting up SendGrid

You need your SendGrid API key and some dynamic templates to send the emails.

• Follow this guide to get your API key
• Add your SendGrid API key to .env.local as the SENDGRID_API_KEY environment variable
• Follow this guide to set up dynamic templates
• Copy your IDs into the templateId properties in src/app/api/liveblocks-notifications-as-html/route.ts

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 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-comments-emails-sendgrid --vercel

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

Develop on CodeSandbox

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