This guide will help you integrate RudderStack with your Next.js app using the JavaScript SDK v3. On successful integration, you can track and send real-time user events to your preferred destinations via RudderStack.
To set up the event stream on your Next.js app, you need to perform the following steps:
The RudderStack JavaScript source is required track the events from your Next.js app. Follow these steps to set it up in your RudderStack dashboard:
Note the data plane URL in your RudderStack dashboard. This is required to set up the JavaScript SDK in your Next.js app.
Click the Sources button in the left navigation bar and select New Source to create a source. Under Sources, select Event Streams > JavaScript.
Assign a name to your source and click Continue.
Your JavaScript source is now configured. Note down the write key for this source:
Install and configure the SDK in your app
You can integrate RudderStack with your Next.js app and set up the tracking code by following the steps below:
In your Next.js project folder, create a useRudderAnalytics.ts file with the following code:
import{useEffect,useState}from'react';importtype{RudderAnalytics}from'@rudderstack/analytics-js';constuseRudderStackAnalytics=():RudderAnalytics|undefined=>{const[analytics,setAnalytics]=useState<RudderAnalytics>();useEffect(()=>{if(!analytics){constinitialize=async()=>{const{RudderAnalytics}=awaitimport('@rudderstack/analytics-js');constanalyticsInstance=newRudderAnalytics();analyticsInstance.load('WRITE_KEY','DATA_PLANE_URL');analyticsInstance.ready(()=>{console.log('We are all set!!!');});setAnalytics(analyticsInstance);};initialize().catch(e=>console.log(e));}},[analytics]);returnanalytics;};exportdefaultuseRudderStackAnalytics;
Replace WRITE_KEY and DATA_PLANE_URL with your JavaScript source write key and the data plane URL obtained in the Creating a JavaScript source in RudderStack section above.
To buffer the events triggered before the SDK is loaded, add the following script in the layout.tsx file within the src folder:
importScriptfrom'next/script';exportdefaultfunctionRootLayout({children}:{children:React.ReactNode}){return(<htmllang='en'><head><Scriptid='bufferEvents'>{`
window.rudderanalytics = [];
var methods = [
'setDefaultInstanceKey',
'load',
'ready',
'page',
'track',
'identify',
'alias',
'group',
'reset',
'setAnonymousId',
'startSession',
'endSession',
'consent'
];
for (var i = 0; i < methods.length; i++) {
var method = methods[i];
window.rudderanalytics[method] = (function (methodName) {
return function () {
window.rudderanalytics.push([methodName].concat(Array.prototype.slice.call(arguments)));
};
})(method);
}
// Below line is only for demonstration purpose, SPA code is better place for auto page call
window.rudderanalytics.page('sample page call');
`}</Script></head><bodyclassName={inter.className}>{children}</body></html>);}
If you are using an app router, go to the app folder and open the page.tsx file. If you are using a page router, go to the pages folder and open the index.tsx file. Then, add the following code:
This section details the steps required to set up a destination in RudderStack, where you can send all events tracked by the JavaScript SDK you set up above.
In your RudderStack dashboard, click Destinations > New destination.
Choose your preferred destination from the list.
Assign a name to the destination and click Continue.
Select the JavaScript source configured in the above section and click Continue.
Configure the destination with the required settings.
Optionally, you can add a user transformation to this destination to transform your events.
Deploy your app and verify events
To verify if your event stream is working correctly, deploy your Next.js app and test if the events are tracked and delivered correctly. To do so, follow these steps:
From your terminal, navigate to the folder containing your Next.js app and run following command:
npm run dev
Open the local server URL(generally http://localhost:3000/) in your browser to view the app.
Go to your browser’s developer tools and open the Network tab. Click the buttons in your app to trigger the RudderStack events.
Verify in the Network tab if the events are sent successfully:
Go to the Live Events tab of your JavaScript source in the RudderStack dashboard to check if the events are tracked. Note that you may face a minor delay before the events start showing up in your dashboard.
Go to your destination to verify if the events are received successfully.
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.