PostHog Plugin Scaffold

This project contains shared typescript types that PostHog plugin authors can use.

# if using yarn
yarn add --dev @posthog/plugin-scaffold

# if using npm
npm install --save-dev @posthog/plugin-scaffold

Then in your plugins:

import { PluginEvent, PluginInput, PluginMeta } from "@posthog/plugin-scaffold";

export function processEvent(event: PluginEvent, meta: PluginMeta<PluginInput>) {
    if (event.properties) {
        event.properties['hello'] = 'world'
    }
    return event
}

Releasing a new version

It's magic! Just bump up version in package.json on the main branch and the new version will be published automatically, on GitHub and on npm. Courtesy of GitHub Actions.

Questions?

Join our Slack community.