Skip to content

A quick PostHog plugin starting point

License

Notifications You must be signed in to change notification settings

PostHog/posthog-plugin-starter-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PostHog Plugin Starter Kit

License: MIT

This is a PostHog plugin template.

The existing sample code adds property "greeting" to every event with a configurable value (default: "Hello world!").
But that is just to help you get started! To make it your own:

  • Add your code to index.js.
  • Add your metadata and configuration schema to plugin.json.
  • Search for <TODO:, make sure none are left!
  • Optional: Add a logo.png file to give this plugin its own logo.
  • Create a README.MD for your plugin which follows our documentation guidelines.

If you're looking for inspiration, then check out url normalizer transformation or compose webhook destination

To get up to speed with the environment of plugins, check out our Plugins overview in PostHog Docs.

Installation

  1. Open PostHog.
  2. Go to the Plugins page from the sidebar.
  3. Head to the Advanced tab.
  4. "Install from GitHub, GitLab or npm" using this repository's URL.

Submitting your plugin to PostHog

When you're done, you can submit your plugin to our integration library so that it can be used by other users, including those on PostHog Cloud.

To submit your plugin, use the support option in PostHog Cloud.

We'll review the plugin to ensure it's secure, performant, adheres to best practices and isn't already doing something that can be accomplished by other means. Then we'll add it to our official repository and make it available for everyone to use!