Meteor Intercom

A package to use Intercom.io easily with Meteor.

NOTE: Package updates are released under verso:intercom as it replaces percolate:intercom.

Installation

Intercom can be installed with Meteor's package manager:

$ meteor add verso:intercom

API

Ensure you have Meteor.settings.intercom.secret and Meteor.settings.public.intercom.id defined to the values provided to you by Intercom. API Keys are being deprecated. You can define the Meteor.settings.intercom.personalAccessToken if you intend to use Intercom on the server side, otherwise you can still define Meteor.settings.intercom.apikey.

Some Intercom subscription packages allow for anonymous users. To enable the use of anonymous users, set Meteor.settings.public.intercom.allowAnonymous to true.

By default, the package will send up the user's id, creation date, and hash (if defined, see below). To send custom data, set:

IntercomSettings.userInfo = function(user, info) {
  // add properties to the info object, for instance:
  if (user.services.google) {
    info.email = user.services.google.email;
    info['name'] = user.services.google.given_name + ' ' + user.services.google.family_name;
  }
}

email and name are preset fields provided by Intercom. You may add any additional custom user attribute.

If you need to wait on a user subscription for e.g. the hash to come down, you can return false in your userInfo function to tell the package to wait.

IntercomSettings.userInfo = function (user, info) {
  if (!user.intercomHash) {
    return false; // the hash isn't loaded to the users collection yet. come back later.
  }
  // ...
}

If you want to add fields sent to intercom for an anonymous user, you can add them through in the anonymousInfo function.

IntercomSettings.anonymousInfo = function ( info ) {
  // check all router subscriptions have loaded
  if (!Router.current() || !Router.current().ready())
    return false;

  info.anonymous = true;
  return;
};

On the server, you can also interact with the Intercom API via the official intercom-node client.

const client = IntercomClient();

// Create an event for a user
client.events.create({
  event_name: 'Test event',
  created_at: Math.floor(new Date().getTime() / 1000),
  user_id: '<Insert meteor user id>'
}, function (d) {
  console.log(d);
});

Notes

This package will automatically subscribe the current user to the currentUserIntercomHash publication which will add an intercomHash property to your user documents enabling the use of intercom's secure mode.

Other References

Integrating intercom.io into a meteor app. https://meteoruniversity.org/integrating-intercom-io-into-a-meteor-app/

License

MIT. (c) Percolate Studio

Meteor Intercom was developed as part of the Verso project.