Nuxt.js (v3.0 to v3.6)

PostHog makes it easy to get data about usage of your Nuxt.js app. Integrating PostHog into your app enables analytics about user behavior, custom events capture, session replays, feature flags, and more.

These docs are for Nuxt v3.0 to v3.6. You can see a working example of the Nuxt v3.0 integration in our Nuxt.js demo app

Setting up PostHog on the client side

Install posthog-js using your package manager:

npm install --save posthog-js

Add your PostHog API key and host to your nuxt.config.js file. You can find these in your project settings.

nuxt.config.js

export default defineNuxtConfig({
  runtimeConfig: {
    public: {
      posthogPublicKey: process.env.NUXT_PUBLIC_POSTHOG_KEY || '<ph_project_api_key>',
      posthogHost: process.env.NUXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com',
      posthogDefaults: '2025-11-30',
    },
  }
})

Create a new plugin by creating a new file posthog.client.js in your plugins directory.

plugins/posthog.client.js

import { defineNuxtPlugin, useRuntimeConfig } from '#imports'

import posthog from 'posthog-js'

export default defineNuxtPlugin(() => {
  const runtimeConfig = useRuntimeConfig()
  const posthogClient = posthog.init(runtimeConfig.public.posthogPublicKey, {
    api_host: runtimeConfig.public.posthogHost,
    defaults: runtimeConfig.public.posthogDefaults,
    loaded: (posthog) => {
      if (import.meta.env.MODE === 'development') posthog.debug()
    },
  })

  return {
    provide: {
      posthog: () => posthogClient,
    },
  }
})

PostHog can then be accessed throughout your Nuxt.js using the provider accessor, for example:

Vue

<script setup>
   const { $posthog } = useNuxtApp()
   if ($posthog) {
      const posthog = $posthog()
      posthog.capture('<event_name>')
   }
</script>

See the JavaScript SDK docs for all usable functions, such as:

Set up a reverse proxy (recommended)

We recommend setting up a reverse proxy, so that events are less likely to be intercepted by tracking blockers.

We have our own managed reverse proxy service included in the platform packages, which routes through our infrastructure and makes setting up your proxy easy.

If you don't want to use our managed service then there are several other options for creating a reverse proxy, including using Cloudflare, AWS Cloudfront, and Vercel.

Grouping products in one project (recommended)

If you have multiple customer-facing products (e.g. a marketing website + mobile app + web app), it's best to install PostHog on them all and group them in one project.

This makes it possible to track users across their entire journey (e.g. from visiting your marketing website to signing up for your product), or how they use your product across multiple platforms.

Add IPs to Firewall/WAF allowlists (recommended)

For certain features like heatmaps, your Web Application Firewall (WAF) may be blocking PostHog’s requests to your site. Add these IP addresses to your WAF allowlist or rules to let PostHog access your site.

EU: 3.75.65.221, 18.197.246.42, 3.120.223.253

US: 44.205.89.55, 52.4.194.122, 44.208.188.173

These are public, stable IPs used by PostHog services (e.g., Celery tasks for snapshots).

Setting up PostHog on the server side

Install posthog-node using your package manager:

npm install posthog-node --save

Add your PostHog API key and host to your nuxt.config.js file. If you've already done this when adding PostHog to the client side, you can skip this step.

nuxt.config.js

export default defineNuxtConfig({
  runtimeConfig: {
    public: {
      posthogPublicKey: '<ph_project_api_key>',
      posthogHost: 'https://us.i.posthog.com',
      posthogDefaults: '2025-11-30',
    }
  }
})

Initialize the PostHog Node client where you'd like to use it on the server side. For example, in a server route:

server/api/example.js


  const runtimeConfig = useRuntimeConfig()

  const posthog = new PostHog(
    runtimeConfig.public.posthogPublicKey,
    { 
      host: runtimeConfig.public.posthogHost, 
    }
  );

  posthog.capture({
    event: 'api_call',
    distinctId: distinctId,
    properties: {
      $current_url: url,
      query: query
    }
  })
  posthog.shutdown()

  return {
    message: "example response"

Note: Make sure to always call posthog.shutdown() after capturing events from the server-side. PostHog queues events into larger batches, and this call forces all batched events to be flushed immediately.

See the Node SDK docs for all usable functions, such as:

Next steps

For any technical questions for how to integrate specific PostHog features into Nuxt (such as analytics, feature flags, A/B testing, surveys, etc.), have a look at our JavaScript Web and Node SDK docs.

Alternatively, the following tutorials can help you get started:

Nuxt.js (v3.0 to v3.6)

Contents

Setting up PostHog on the client side

Setting up PostHog on the server side

Next steps

Community questions

Was this page useful?