Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

4.1 KB
Raw Blame
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'

import { StepDefinition } from '../steps'

export const getNodeJSInstallSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
    const { CodeBlock, Markdown, dedent } = ctx

    return [
        {
            title: 'Install the package',
            badge: 'required',
            content: (
                <>
                    <Markdown>Install the PostHog Node.js library using your package manager:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'bash',
                                file: 'npm',
                                code: dedent`
                                npm install posthog-node
                            `,
                            },
                            {
                                language: 'bash',
                                file: 'yarn',
                                code: dedent`
                                yarn add posthog-node
                            `,
                            },
                            {
                                language: 'bash',
                                file: 'pnpm',
                                code: dedent`
                                pnpm add posthog-node
                            `,
                            },
                            {
                                language: 'bash',
                                file: 'bun',
                                code: dedent`
                                bun add posthog-node
                            `,
                            },
                        ]}
                    />
                </>
            ),
        },
        {
            title: 'Initialize PostHog',
            badge: 'required',
            content: (
                <>
                    <Markdown>Initialize the PostHog client with your project token:</Markdown>
                    <CodeBlock
                        blocks={[
                            {
                                language: 'javascript',
                                file: 'Node.js',
                                code: dedent`
                                import { PostHog } from 'posthog-node'

                                const client = new PostHog(
                                    '<ph_project_token>',
                                    {
                                        host: '<ph_client_api_host>'
                                    }
                                )
                            `,
                            },
                        ]}
                    />
                </>
            ),
        },
    ]
}

export const getNodeJSEventStep = (ctx: OnboardingComponentsContext): StepDefinition => {
    const { CodeBlock, Markdown, dedent } = ctx

    return {
        title: 'Send an event',
        badge: 'recommended',
        content: (
            <>
                <Markdown>Once installed, you can manually send events to test your integration:</Markdown>
                <CodeBlock
                    blocks={[
                        {
                            language: 'javascript',
                            file: 'Node.js',
                            code: dedent`
                                client.capture({
                                    distinctId: 'distinct_id_of_the_user',
                                    event: 'event_name',
                                    properties: {
                                        property1: 'value',
                                        property2: 'value',
                                    },
                                })
                            `,
                        },
                    ]}
                />
            </>
        ),
    }
}

export const getNodeJSSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => [
    ...getNodeJSInstallSteps(ctx),
    getNodeJSEventStep(ctx),
]

export const NodeJSInstallation = createInstallation(getNodeJSSteps)