This analytics plugin will load HubSpot's client side tracking script into your application and send custom events, page views, and identify visitors inside HubSpot.

View the docs

Click to expand

Installation

Install analytics and @analytics/hubspot packages

npm install analytics
npm install @analytics/hubspot

How to use

The @analytics/hubspot package works in the browser. 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.

import Analytics from 'analytics'
import hubSpotPlugin from '@analytics/hubspot'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    hubSpotPlugin({
      portalId: '234576'
    })
  ]
})

/* Track a page view */
analytics.page()

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

/* Identify a visitor */
analytics.identify({
  name: 'bob',
  email: 'bob@bob.com' // email is required
})

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

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

Platforms Supported

The @analytics/hubspot package works in the browser

Browser usage

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

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

Browser API

import Analytics from 'analytics'
import hubSpotPlugin from '@analytics/hubspot'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    hubSpotPlugin({
      portalId: '234576'
    })
  ]
})

Configuration options for browser

Option	description
`portalId` required - string	The HubSpot Portal (or Hub) Id of your HubSpot account
`customScriptSrc` optional - string	Load hubspot script from custom source
`flushOnIdentify` optional - boolean	Fire immediate page view to send identify information

Additional examples

Below are additional implementation examples.

Using in HTML

Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/hubspot in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/@analytics/hubspot/dist/@analytics/hubspot.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: 'my-app-name',
        plugins: [
          analyticsHubspot({
            portalId: '234576'
          })
        ]
      })

      /* Track a page view */
      analytics.page()

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

      /* Identify a visitor */
      analytics.identify({
        name: 'bob',
        email: 'bob@bob.com' // email is required
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Using in HTML via ES Modules

Using @analytics/hubspot in ESM modules.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/hubspot in HTML via ESModules</title>
    <script>
      // Polyfill process.
      // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
      window.process = window.process || { env: { NODE_ENV: 'production' } }
    </script>
    <script type="module">
      import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
      import analyticsHubspot from 'https://unpkg.com/@analytics/hubspot/lib/analytics-plugin-hubspot.browser.es.js?module'
      /* Initialize analytics */
      const Analytics = analytics({
        app: 'analytics-html-demo',
        debug: true,
        plugins: [
          analyticsHubspot({
            portalId: '234576'
          })
          // ... add any other third party analytics plugins
        ]
      })

      /* Track a page view */
      analytics.page()

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

      /* Identify a visitor */
      analytics.identify({
        name: 'bob',
        email: 'bob@bob.com' // email is required
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Using identify

Important: HubSpot requires an email field for making identify calls.

If your identify call does not contain email HubSpot will not be notified of the new user.

When sending properties with identify calls, all camelCase traits are automatically converted to snake_case. There is one exception to this for firstName & lastName which are sent as firstname & lastname.

Example:

analytics.identify('user-xzy-123', {
  email: 'bill@murray.com',
  accountLevel: 'pro' // trait will be `account_level`
})

Keywords

FAQs

What is @analytics/hubspot?

Is @analytics/hubspot popular?

Is @analytics/hubspot well maintained?

Package last updated on 11 Mar 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@analytics/hubspot