Intercom plugin for analytics

Integration with intercom for analytics

For more information see the docs.

Installation

``bash
npm install analytics
npm install @analytics/intercom
`

How to use

The @analytics/intercom package works in the browser and server-side in Node.js. To use, install the package, include in your project and initialize the plugin with analytics.

Below is an example of how to use the browser plugin.

`js
import Analytics from 'analytics'
import intercomPlugin from '@analytics/intercom'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
intercomPlugin({
appId: '123-xyz'
})
]
})

/ Track a page view /
analytics.page()

/ Track a custom event /
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})

/ Identify a visitor /
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})

`

After initializing analytics with the intercomPlugin plugin, data will be sent into Intercom whenever analytics.page, analytics.track, or analytics.identify are called.

See additional implementation examples for more details on using in your project.

Platforms Supported

The @analytics/intercom package works in the browser and server-side in Node.js

Browser usage

The Intercom client side browser plugin works with these analytic api methods:

- analytics.page - Sends page views into Intercom
- analytics.track - Track custom events and send to Intercom
- analytics.identify - Identify visitors and send details to Intercom
- analytics.reset - Reset browser storage cookies & localstorage for Intercom values

$3

`js
import Analytics from 'analytics'
import intercomPlugin from '@analytics/intercom'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
intercomPlugin({
appId: '123-xyz'
})
]
})

`

$3

| Option | description |
|:---------------------------|:-----------|
| appId
required - string| Your intercom app id |
| disableAnonymousTraffic
_optional_ - boolean| Disable loading intercom for anonymous visitors |
| alignment
_optional_ - string| Customize left or right position of messenger |
| horizontalPadding
_optional_ - number| Customize horizontal padding |
| verticalPadding
_optional_ - number| Customize vertical padding |
| customLauncherSelector
_optional_ - string| Css selector of the custom launcher see https://www.intercom.com/help/en/articles/2894-customize-the-intercom-messenger-technical for additional info |

Server-side usage

The Intercom server-side node.js plugin works with these analytic api methods:

- analytics.page - Sends page views into Intercom
- analytics.track - Track custom events and send to Intercom
- analytics.identify - Identify visitors and send details to Intercom

$3

`js
import Analytics from 'analytics'
import intercomPlugin from '@analytics/intercom'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
intercomPlugin({
appId: '123-xyz'
})
]
})

`

$3

| Option | description |
|:---------------------------|:-----------|
| appId
required - string| Your Intercom app id |

Additional examples

Below are additional implementation examples.

Custom browser methos

This plugin exposes some custom intercom methods thanks to custom methods on plugins.

See reference api for additional information

$3

startTour(tourId)
shutdown()
hide()
show()
showMessages()
showNewMessage()

$3

The following methods require a function as an argument
onShow(callback)
onUnreadCountChange(callback)

$3

`js
import Analytics from "analytics";
import intercomPlugin from "@analytics/intercom";

// Initialize analytics instance with plugins
const analytics = Analytics({
app: "your-app-name",
plugins: [
intercomPlugin({
appId: "123-xyz",
}),
],
});

// Usage:
// Now you can call intercom.startTour in your app like so
analytics.plugins.intercom.startTour("tourID");

// hook usage:
analytics.plugins.intercom.onShow(() => {
console.log("fires when intercom launcher is shown");
});
``