README.md

Intercom for Cordova/PhoneGap

This is a plugin that allows your Cordova or PhoneGap app to use Intercom for iOS and/or Intercom for Android.

• Intercom for iOS supports iOS 8, 9, 10 & 11.
• Intercom for Android supports API 19 and above.

Customer Support

👋 We are moving all our issues support to our Intercom Developer Hub available here. If you bump into any problems or need more support, just start a conversation using Intercom there and it will be immediately routed to our Customer Support Engineers.

Installation

Cordova

To install the plugin in your Cordova app, run the following:

cordova plugin add cordova-plugin-intercom

PhoneGap

To add the plugin to your PhoneGap app, add the following to your config.xml:

<plugin name="cordova-plugin-intercom" version="~6.1.0" />

Ionic

Intercom is compatible with both Ionic 1 & 2. To use the Intercom with Ionic, run the following:

cordova plugin add cordova-plugin-intercom

Make sure you initialize Intercom correctly.

Ionic 1

For Ionic 1 you can use Intercom like this:

.run(function($ionicPlatform) {
  $ionicPlatform.ready(function() {
    cordova.plugins.intercom.registerIdentifiedUser({userId: "123456"});
    cordova.plugins.intercom.setLauncherVisibility('VISIBLE');
  });
})

Ionic 2

For Ionic 2 you need to add the folling variable to your app.component.ts:

declare var cordova:any;

You can then use Intercom like this:

this.platform.ready().then(() => {
    cordova.plugins.intercom.registerIdentifiedUser({userId: "12345"});
    cordova.plugins.intercom.setLauncherVisibility('VISIBLE');
});

Example App

An example app is provided here that shows a basic Cordova/Phonegap app integration with Intercom.

Setup and Configuration

• Our installation guide contains full setup and initialisation instructions.
• The configuration guide provides info on how to configure Intercom for Cordova/Phonegap.
• Read our guide on Push Notifications support.
• Please contact us on Intercom with any questions you may have, we're only a message away!

Acknowledgements

Thanks to Josh Dover from AskU for making a Cordova plugin for Intercom for iOS which helped lots of people to integrate Intercom in their iOS Cordova apps. 👍

License

intercom-cordova is released under the MIT License.