Like Jitsu? Give us a star on ā­ GitHub!

šŸ“œ Configuration

Configuration UI

šŸ‘©ā€šŸ”¬ Extending Jitsu

Overview
Destination Extensions
Source Extensions
API Specs

Jitsu Internals

NPM plugins

Jitsu supports Destination Plugins. New type of destination may be added to Jitsu Server from npm package.

Configuration

NPM based destination configs consist of the following schema:

destinations:
  my_plugin:
    type: npm
    package: jitsu-custom-destination@^1.0.0
    mode: stream
    config:
      #config depends on particular plugin implementation

Plugin Configuration Parameters

ParameterDescription
package (required)package can be:
  • npm package name - if a plugin is published to npm repository. We recommend providing package name with version expression to prevent backward compatibility issues: jitsu-slack-destination@^1.0.0
  • HTTP URL - e.g.: https://my-site.com/plugins/jitsu-slack-destination.tgz
  • filesystem path - in case of a docker image, provided path needs to be reachable inside of docker image filesystem. /home/eventnative/data/plugins/ needs to be mounted to host filesystem directory where plugin's .tgz is located, e.g. following param may be added to docker run command: -v /Users/testaccount/projects/:/home/eventnative/data/plugins/

Mixpanel v2 Plugin Example

destinations:
  mixpanel2:
    type: npm
    package: jitsu-mixpanel-destination@^0.2.0
    mode: stream
    config:
      anonymous_users_enabled: false
      api_secret: "abc"
      project_id: "123456"
      token: "ZZZZZZZ"
      users_enabled: true