integration-nextjs-pages-router

name	integration-nextjs-pages-router
description	PostHog integration for Next.js Pages Router applications
metadata	{"author":"PostHog","version":"1.27.0"}

PostHog integration for Next.js Pages Router

This skill helps you add PostHog analytics to Next.js Pages Router applications.

Workflow

Follow these steps in order to complete the integration:

1. references/1-begin.md - PostHog Setup - Begin ← Start here
2. references/2-edit.md - PostHog Setup - Edit
3. references/3-revise.md - PostHog Setup - Revise
4. references/4-conclude.md - PostHog Setup - Conclusion

Reference files

• references/EXAMPLE.md - Next.js Pages Router example project code
• references/1-begin.md - Start the event tracking setup process by analyzing the project and creating an event tracking plan
• references/2-edit.md - Implement PostHog event tracking in the identified files, following best practices and the example project
• references/3-revise.md - Review and fix any errors in the PostHog integration implementation
• references/4-conclude.md - Review and fix any errors in the PostHog integration implementation
• references/next-js.md - Next.js - docs
• references/identify-users.md - Identify users - docs

The example project shows the target implementation pattern. Consult the documentation for API details.

Key principles

• Environment variables: Always use environment variables for PostHog keys. Never hardcode them.
• Minimal changes: Add PostHog code alongside existing integrations. Don't replace or restructure existing code.
• Match the example: Your implementation should follow the example project's patterns as closely as possible.

Framework guidelines

• For Next.js 15.3+, initialize PostHog in instrumentation-client.ts for the simplest setup
• For feature flags, use useFeatureFlagEnabled() or useFeatureFlagPayload() hooks - they handle loading states and external sync automatically
• Add analytics capture in event handlers where user actions occur, NOT in useEffect reacting to state changes
• Do NOT use useEffect for data transformation - calculate derived values during render instead
• Do NOT use useEffect to respond to user events - put that logic in the event handler itself
• Do NOT use useEffect to chain state updates - calculate all related updates together in the event handler
• Do NOT use useEffect to notify parent components - call the parent callback alongside setState in the event handler
• To reset component state when a prop changes, pass the prop as the component's key instead of using useEffect
• useEffect is ONLY for synchronizing with external systems (non-React widgets, browser APIs, network subscriptions)
• Remember that source code is available in the node_modules directory
• Check package.json for type checking or build scripts to validate changes
• When a reverse proxy is configured, both /static/* AND /array/* must route to the assets origin (us-assets.i.posthog.com or eu-assets.i.posthog.com).
• posthog-js is the JavaScript SDK package name
• posthog.init() MUST be called before any other PostHog methods (capture, identify, etc.)
• posthog-js is browser-only — do NOT import it in Node.js or server-side contexts (use posthog-node instead)
• Autocapture is ON by default with posthog-js (tracks clicks, form submissions, pageviews). Do NOT disable autocapture unless the user explicitly requests it.
• NEVER send PII in posthog.capture() event properties — no emails, full names, phone numbers, physical addresses, IP addresses, or user-generated content
• PII belongs in posthog.identify() person properties (email, name, role), NOT in capture() event properties
• Call posthog.identify(userId, { email, name, role }) on login AND on page refresh if the user is already logged in
• Call posthog.reset() on logout to unlink future events from the current user
• For SPAs without a framework router, capture pageviews with posthog.capture($pageview) or use the capture_pageview history_change option in init for History API routing
• posthog-node is the Node.js server-side SDK package name – do NOT use posthog-js on the server
• Include enableExceptionAutocapture: true in the PostHog constructor options
• Add posthog.capture() calls in route handlers for meaningful user actions – every route that creates, updates, or deletes data should track an event with contextual properties
• Add posthog.captureException(err, distinctId) in the application's error handler (e.g., Express error middleware, Fastify setErrorHandler, Koa app.on('error'))
• In long-running servers, the SDK batches events automatically – do NOT set flushAt or flushInterval unless you have a specific reason to
• For short-lived processes (scripts, CLIs, serverless), set flushAt to 1 and flushInterval to 0 to send events immediately
• Reverse proxy is NOT needed for server-side Node.js – only client-side JavaScript needs a proxy to avoid ad blockers

Identifying users

Identify users during login and signup events. Refer to the example code and documentation for the correct identify pattern for this framework. If both frontend and backend code exist, pass the client-side session and distinct ID using X-POSTHOG-DISTINCT-ID and X-POSTHOG-SESSION-ID headers to maintain correlation.

Error tracking

Add PostHog error tracking to relevant files, particularly around critical user flows and API boundaries.