npm.io
2.22.7 • Published 4d ago

@medusajs/analytics-posthog

Licence
MIT
Version
2.22.7
Deps
0
Size
13 kB
Vulns
0
Weekly
0
Stars
36.6K

Medusa logo

@medusajs/analytics-posthog

Documentation | Website

Building blocks for digital commerce

Medusa is released under the MIT license. PRs welcome! Discord Chat Follow @medusajs

PostHog Analytics Module Provider for Medusa: sends events and identities tracked through the Analytics Module to PostHog. Use it to track commerce events (such as orders placed or carts updated) in PostHog from your workflows and subscribers. It ships with @medusajs/medusa and is registered through the @medusajs/medusa/analytics-posthog path.

At a glance

Package @medusajs/analytics-posthog
Type Module Provider (Analytics Module)
Provider ID analytics-posthog
Registered by default No
Import from @medusajs/medusa/analytics-posthog

Installation

No installation needed. The provider is a dependency of @medusajs/medusa.

Usage

Register the provider in the Analytics Module's providers array in medusa-config.ts. The Analytics Module accepts exactly one provider.

import { defineConfig } from "@medusajs/framework/utils"

module.exports = defineConfig({
  // ...
  modules: [
    {
      resolve: "@medusajs/medusa/analytics",
      options: {
        providers: [
          {
            resolve: "@medusajs/medusa/analytics-posthog",
            id: "posthog",
            options: {
              posthogEventsKey: process.env.POSTHOG_EVENTS_API_KEY,
              posthogHost: process.env.POSTHOG_HOST,
            },
          },
        ],
      },
    },
  ],
})

Configuration

Option Type Description Default
posthogEventsKey string Required. The PostHog project API key used to send events. -
posthogHost string The PostHog instance URL. https://eu.i.posthog.com
Environment variable Description
POSTHOG_EVENTS_API_KEY Value for posthogEventsKey, as used in the example above.
POSTHOG_HOST Value for posthogHost, as used in the example above.

Resources

Keywords