NextAuth.js Lead Tracking

Conversion tracking requires a Pro plan subscription or higher (or an active conversion trial).

When it comes to conversion tracking, a lead event happens when a user performs an action that indicates interest in your product or service. This could be anything from:

Signing up for an account
Adding a product to cart
Joining a mailing list

A diagram showing how lead events are tracked in the conversion funnel

In this guide, we will be focusing on tracking new user sign-ups for a SaaS application that uses NextAuth.js for user authentication.

Prerequisites

Before you get started, make sure you follow the CodeQR Conversions quickstart guide to get CodeQR Conversions set up for your links:

Configure NextAuth.js Options

Then, set up your NextAuth.js configuration options to track lead conversion events using the codeqr TypeScript SDK. Here’s how it works in a nutshell:

Use NextAuth’s signIn event to detect when there’s a new sign up.
If the user is a new sign up, check if the cq_id cookie is present.
If the cq_id cookie is present, send a lead event to CodeQR using codeqr.track.lead
Delete the cq_id cookie.

Under the hood, CodeQR records the user as a customer and associates them with the click event that they came from. The user’s unique ID is now the source of truth for all future events – hence why we don’t need the cq_id cookie anymore.

// app/api/auth/[...nextauth]/options.ts
import type { NextAuthOptions } from "next-auth";
import { cookies } from "next/headers";
import { codeqr } from "@/lib/codeqr";

export const authOptions: NextAuthOptions = {
  ...otherAuthOptions, // your other NextAuth options
  events: {
    async signIn(message) {
      // if it's a new sign up
      if (message.isNewUser) {
        // check if cq_id cookie is present
        const cq_id = cookies().get("cq_id")?.value;
        if (cq_id) {
          // send lead event to CodeQR
          await codeqr.track.lead({
            clickId: cq_id,
            eventName: "Sign Up",
            customerExternalId: user.id,
            customerName: user.name,
            customerEmail: user.email,
            customerAvatar: user.image,
          });
          // delete the cq_id cookie
          cookies().set("cq_id", "", {
            expires: new Date(0),
          });
        }
      }
    },
  },
};

// pages/api/auth/[...nextauth]/options.ts
import type { NextApiRequest } from "next";
import type { NextAuthOptions } from "next-auth";
import { codeqr } from "@/lib/codeqr";

export const getOptions = (req: NextApiRequest): NextAuthOptions => ({
  ...otherAuthOptions, // your other NextAuth options
  events: {
    async signIn(message) {
      // if it's a new sign up
      if (message.isNewUser) {
        // check if cq_id cookie is present
        const { cq_id } = req.cookies;
        if (cq_id) {
          // send lead event to CodeQR
          await codeqr.track.lead({
            clickId: cq_id,
            eventName: "Sign Up",
            customerExternalId: user.id,
            customerName: user.name,
            customerEmail: user.email,
            customerAvatar: user.image,
          });
        }
      }
    },
  },
});

In NextAuth.js, the isNewUser flag will only be available if you’re using next-auth’s database implementation (otherwise it’ll return undefined). In that case, you should move the logic above to the signIn callback instead.

Here’s the full list of attributes you can pass when sending a lead event:

Property	Required	Description
`clickId`	Yes	The unique `cq_id` parameter that the lead conversion event is attributed to.
`eventName`	Yes	The name of the event. Example: “Sign up”.
`customerExternalId`	Yes	The unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer.
`customerEmail`	No	The email address of the customer.
`customerName`	No	The name of the customer. If not passed, a random name will be generated (e.g. “Big Red Caribou”).
`customerAvatar`	No	The avatar URL of the customer.

Create a NextAuth.js Route Handler

Finally, import the authOptions variable you created earlier and use NextAuth to create a handler for your NextAuth.js routes.

// app/api/auth/[...nextauth]/index.ts
import { authOptions } from "./options";
import NextAuth from "next-auth";

const handler = NextAuth(authOptions);

export { handler as GET, handler as POST };

// pages/api/auth/[...nextauth]/index.ts
import type { NextApiRequest, NextApiResponse } from "next";
import NextAuth from "next-auth";
import { getOptions } from "./options";

const handler = (req: NextApiRequest, res: NextApiResponse) =>
  NextAuth(req, res, getOptions(req));

export default handler;

View your conversions

Once you’ve enabled conversion tracking for your links, all your tracked conversions will show up on your Analytics dashboard. We provide 3 different views to help you understand your conversions:

Time-series: A time-series view of the number clicks, leads and sales.

Funnel chart: A funnel chart view visualizing the conversion & dropoff rates across the different steps in the conversion funnel (clicks → leads → sales).

Funnel chart view showing the conversion & dropoff rates from clicks → leads → sales

Real-time events stream: A real-time events stream of every single conversion event that occurs across all your links in your project.

Getting Started

Links

QR Codes

Integrations

NextAuth.js

Prerequisites

Configure NextAuth.js Options

Create a NextAuth.js Route Handler

View your conversions

​Prerequisites

​Configure NextAuth.js Options

​Create a NextAuth.js Route Handler

​View your conversions

Prerequisites

Configure NextAuth.js Options

Create a NextAuth.js Route Handler

View your conversions