Botkit plugin for Mixpanel analytics https://botkit.ai
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.editorconfig
.gitignore
package-lock.json
package.json
readme.md

readme.md

Botkit Mixpanel Analytics

This module enables the basic Mixpanel analytics.

npm install --save botkit-mixpanel

Add the following to your code AFTER you initialize your Botkit controller:

var controller = Botkit.slackbot();
require('botkit-mixpanel')(controller,  {mixpanel_api_key: process.env.MIXPANEL_API_KEY, debug: true, always_update: true});

Options

Enable debug output:

require('botkit-mixpanel')(controller,  {mixpanel_api_key: process.env.MIXPANEL_API_KEY, debug: true, always_update: true});

By default, this module will only send user profile and bot instance information the first time an event is received. To update this information every time an event is received, include the always_update option:

require('botkit-mixpanel')(controller,  {mixpanel_api_key: process.env.MIXPANEL_API_KEY, debug: true, always_update: true});

Data collection

With this module installed and enabled, your Botkit application will automatically send a copy of any message your bot receives to Mixpanel's analytics API, as well as user profile information.

Where applicable, ensure that your terms of service and privacy policy reflect this data collection.