Skip to main content
Neon Postgres Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

Magic Link

Managed Better Auth is built on Better Auth and provides full support for the Magic Link plugin APIs through the Neon SDK. You do not need to manually install or configure the Better Auth Magic Link p...

Managed Better Auth is built on Better Auth and provides full support for the Magic Link plugin APIs through the Neon SDK. You do not need to manually install or configure the Better Auth Magic Link plugin.

Magic Link lets users sign in by clicking a link sent to their email. No password is required. The flow works like this:

  1. The user enters their email address.
  2. Managed Better Auth sends an email containing a unique, time-limited link.
  3. The user clicks the link, which verifies the token, creates a session, and redirects them to your app.
  • A Neon project with Auth enabled
  • The Magic Link plugin enabled (see Enable Magic Link below)
  1. Open the Neon Console.
  2. Select your project and go to Auth > Plugins.
  3. Toggle Magic Link on.
  4. Configure the options:
    • Link Expiration (5-1440 minutes, default: 5) controls how long a magic link stays valid.
    • Allow New User Registration controls whether magic links can be used to create new accounts. When off, magic links only work for existing users.
Neon Console Auth Plugins tab with Magic Link settings

Send a PATCH request to configure the Magic Link plugin. All request body fields are optional; send only the fields you want to change.

Bash
curl -X PATCH \
  "https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth/plugins/magic-link" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "expires_in": 5,
    "disable_sign_up": false
  }'
FieldTypeDefaultDescription
enabledbooleanfalseWhether the Magic Link plugin is active
expires_ininteger5Minutes before the magic link expires (5-1440)
disable_sign_upbooleanfalseWhen true, magic links only work for existing users

Build a custom magic link flow using the Neon SDK. Call signIn.magicLink() with the user's email and a callback URL. Managed Better Auth sends the email and redirects the user to callbackURL after they click the link.

src/send-magic-link.ts
import { authClient } from '@/lib/auth/client';

export async function sendMagicLink(email: string) {
  const { error } = await authClient.signIn.magicLink({
    email,
    callbackURL: '/dashboard',
  });

  if (error) throw error;
}

After calling signIn.magicLink(), show the user a "check your email" message. For a complete working example with error handling, resend, and state management, see the magic link example app in the neon-js repository.

If you're already using Managed Better Auth UI components, you can enable Magic Link with a single prop instead of building a custom form. Pass the magicLink prop to NeonAuthUIProvider:

app/layout.tsx
'use client';

import { authClient } from '@/lib/auth/client';
import { NeonAuthUIProvider } from '@neondatabase/auth-ui';
import '@neondatabase/auth-ui/css';
import './globals.css';

export default function RootLayout({ children }: Readonly<{ children: React.ReactNode }>) {
  return (
    <html lang="en" suppressHydrationWarning>
      <body className={'antialiased'}>
        <NeonAuthUIProvider
          authClient={authClient}
          magicLink
        >
          {children}
        </NeonAuthUIProvider>
      </body>
    </html>
  );
}

Users can now sign in with a magic link by selecting the option on the sign-in screen and entering their email.

If you haven't set up Managed Better Auth UI components yet, see the UI components reference for setup, or the Next.js or React quick start for building custom forms instead.

If you subscribe to the send.magic_link event, Managed Better Auth skips its built-in email and calls your webhook instead, passing link_type: "sign-in" in the payload. Your handler is responsible for delivering the link (for example, via a custom email template or SMS).

See the Webhooks guide for configuration details and payload format.

For production environments, we strongly recommend using a dedicated email provider. The default shared SMTP should be used only during development. See the Email provider configuration guide for setup instructions.

Join our Discord Server to ask questions or see what others are doing with Neon. For paid plan support options, see Support.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu