---
description: Unofficial Capacitor plugin for Intercom to integrate the Intercom Messenger on Android, iOS, and Web with identity verification and push notifications.
title: Capacitor Intercom Plugin for Android, iOS & Web - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/intercom.png
---

<!doctype html> 

[Skip to content ](#capacitor-intercom-plugin) 

[📲 Introducing **Build Sharing** — get your builds onto testers' devices with a link & QR code. No account required. ](/blog/share-mobile-app-builds-with-testers/) 

* [ SDKs ](/docs/sdks/)
* [ Formbricks ](/docs/sdks/capacitor/formbricks/)
* [ Geocoder ](/docs/sdks/capacitor/geocoder/)
* [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/)
* [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/)
* [ Gyroscope ](/docs/sdks/capacitor/gyroscope/)
* [ Haptics ](/docs/sdks/capacitor/haptics/)
* [ Home Indicator ](/docs/sdks/capacitor/home-indicator/)
* [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/)
* [ Install Referrer ](/docs/sdks/capacitor/install-referrer/)
* Intercom [ Intercom ](/docs/sdks/capacitor/intercom/)
* [ iOS ](#ios)
* [ Web ](#web)
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Type Aliases ](#type-aliases)
* [ Migration ](#migration)
* [ Platform Support ](#platform-support)
* [ Licensing ](#licensing)
* [ FAQ ](#faq)
* [ Newsletter ](#newsletter)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Intune ](/docs/sdks/capacitor/intune/)
* [ Keep Awake ](/docs/sdks/capacitor/keep-awake/)
* [ libSQL ](/docs/sdks/capacitor/libsql/)
* [ Light Sensor ](/docs/sdks/capacitor/light-sensor/)
* [ Live Update ](/docs/sdks/capacitor/live-update/)
* [ Localization ](/docs/sdks/capacitor/localization/)
* [ Mail Composer ](/docs/sdks/capacitor/mail-composer/)
* [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/)
* [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/)
* [ Media Session ](/docs/sdks/capacitor/media-session/)
* [ ML Kit ](/docs/sdks/capacitor/mlkit/)
* [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/)
* [ Network ](/docs/sdks/capacitor/network/)
* [ NFC ](/docs/sdks/capacitor/nfc/)
* [ Node.js ](/docs/sdks/capacitor/nodejs/)
* [ OAuth ](/docs/sdks/capacitor/oauth/)
* [ Passkeys ](/docs/sdks/capacitor/passkeys/)
* [ Password Autofill ](/docs/sdks/capacitor/password-autofill/)
* [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/)
* [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/)
* [ Pedometer ](/docs/sdks/capacitor/pedometer/)
* [ Permissions ](/docs/sdks/capacitor/permissions/)
* [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/)
* [ Photo Editor ](/docs/sdks/capacitor/photo-editor/)
* [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/)
* [ PixLive ](/docs/sdks/capacitor/pixlive/)
* [ PostHog ](/docs/sdks/capacitor/posthog/)
* [ Printer ](/docs/sdks/capacitor/printer/)
* [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/)
* [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/)
* [ Purchases ](/docs/sdks/capacitor/purchases/)
* [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/)
* [ Root Detection ](/docs/sdks/capacitor/root-detection/)
* [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/)
* [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/)
* [ Screen Reader ](/docs/sdks/capacitor/screen-reader/)
* [ Screenshot ](/docs/sdks/capacitor/screenshot/)
* [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/)
* [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/)
* [ Shake ](/docs/sdks/capacitor/shake/)
* [ Silent Mode ](/docs/sdks/capacitor/silent-mode/)
* [ SIM ](/docs/sdks/capacitor/sim/)
* [ SMS Composer ](/docs/sdks/capacitor/sms-composer/)
* [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/)
* [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/)
* [ Share Target ](/docs/sdks/capacitor/share-target/)
* [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/)
* [ SQLite ](/docs/sdks/capacitor/sqlite/)
* [ Superwall ](/docs/sdks/capacitor/superwall/)
* [ System WebView ](/docs/sdks/capacitor/system-webview/)
* [ Text Interaction ](/docs/sdks/capacitor/text-interaction/)
* [ Text Zoom ](/docs/sdks/capacitor/text-zoom/)
* [ Thermal State ](/docs/sdks/capacitor/thermal-state/)
* [ Toast ](/docs/sdks/capacitor/toast/)
* [ Torch ](/docs/sdks/capacitor/torch/)
* [ Vault ](/docs/sdks/capacitor/vault/)
* [ Volume ](/docs/sdks/capacitor/volume/)
* [ Wallet ](/docs/sdks/capacitor/wallet/)
* [ Wifi ](/docs/sdks/capacitor/wifi/)
* [ YouTube Player ](/docs/sdks/capacitor/youtube-player/)
* [ Zip ](/docs/sdks/capacitor/zip/)
* [ Cordova ](/docs/sdks/cordova/)
* [ Cloud ](/docs/cloud/)
* [ Integrations ](/docs/cloud/live-updates/integrations/)
* Concepts
* Reference
* [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/)
* [ FAQ ](/docs/cloud/live-updates/faq/)
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Set Up Environments ](/docs/cloud/native-builds/environments/)
* [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/)
* [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/)
* [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/)
* [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/)
* [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/)
* [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/)
* [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/)
* [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/)
* [ Build without Git ](/docs/cloud/native-builds/build-without-git/)
* [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/)
* [ Integrations ](/docs/cloud/native-builds/integrations/)
* Reference
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ FAQ ](/docs/cloud/native-builds/faq/)
* [ App Store Publishing ](/docs/cloud/app-store-publishing/)
* [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/)
* [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/)
* [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/)
* [ FAQ ](/docs/cloud/app-store-publishing/faq/)
* [ Automations ](/docs/cloud/automations/)
* [ Reference ](/docs/cloud/automations/reference/)
* [ Troubleshooting ](/docs/cloud/automations/troubleshooting/)
* [ FAQ ](/docs/cloud/automations/faq/)
* [ Assist ](/docs/cloud/assist/)
* [ CLI ](/docs/cloud/cli/)
* APIs and SDKs
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Integrations ](/docs/cloud/integrations/)
* Account
* [ Organization ](/docs/cloud/organizations/)
* [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/)
* [ Audit Logs ](/docs/cloud/organizations/audit-logs/)
* [ Billing ](/docs/cloud/organizations/billing/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ AI ](/docs/ai/)
* [ Insiders ](/docs/insiders/)
* [ Billing & Plans ](/docs/insiders/billing-and-plans/)
* [ FAQ ](/docs/insiders/faq/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/support/)
* [ Contributing ](/docs/contributing/)
* Contributing code
* [ Code of Conduct ](/docs/contributing/code-of-conduct/)
* [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion)
* [ Blog ](/blog/)
* Categories

* [ iOS ](#ios)
* [ Web ](#web)
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Type Aliases ](#type-aliases)
* [ Migration ](#migration)
* [ Platform Support ](#platform-support)
* [ Licensing ](#licensing)
* [ FAQ ](#faq)
* [ Newsletter ](#newsletter)
* [ Changelog ](#changelog)
* [ License ](#license)

# Capacitor Intercom Plugin[¶](#capacitor-intercom-plugin "Permanent link")

Unofficial Capacitor plugin for [Intercom](https://www.intercom.com/).[1](#fn:1)

[ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) 

## Features[¶](#features "Permanent link")

The Capacitor Intercom plugin is a modern integration of the Intercom SDKs for Capacitor apps. Here are some of the key features:

* 🖥️ **Cross-platform**: Supports Android, iOS, and Web.
* 💬 **Messenger**: Present the Intercom Messenger and its Home, Messages, Help Center, and Tickets spaces.
* 👤 **Identity**: Log in identified or unidentified users with the modern login APIs, wired to the native result callbacks.
* 🔐 **Identity Verification**: Verify the user's identity with a user hash (HMAC) or a JSON Web Token (JWT).
* 🧩 **User Attributes**: Update the user's name, email, phone, custom attributes, and companies.
* 📚 **Content**: Present articles, carousels, surveys, conversations, and help center collections.
* 🔢 **Unread Count**: Read the unread conversation count and listen for changes.
* 🔔 **Push Notifications**: Compose cleanly with Firebase Cloud Messaging (Android) and APNs (iOS).
* 🌐 **Typed Web SDK**: Uses the official `@intercom/messenger-js-sdk` package on the web.
* 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.
* 🔁 **Up-to-date**: Always supports the latest Capacitor version.
* 🤝 **Compatibility**: Looking for a different chat SDK? Check out the [Crisp](https://capawesome.io/docs/sdks/capacitor/crisp/) plugin.

Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!

## Use Cases[¶](#use-cases "Permanent link")

The Intercom plugin is typically used wherever you want to offer live chat and customer support inside your app, for example:

* **Customer support**: Let users chat with your support team directly from within the app.
* **User identification**: Attach the signed-in user's identity and attributes to every conversation.
* **Self-service**: Point users to articles, surveys, and help center collections without leaving the app.
* **Engagement**: Track events and show the unread conversation count in your own UI.
* **Re-engagement**: Notify users about new replies via push notifications.

## Compatibility[¶](#compatibility "Permanent link")

| Plugin Version | Capacitor Version | Status         |
| -------------- | ----------------- | -------------- |
| 0.x.x          | \>=8.x.x          | Active support |

## Installation[¶](#installation "Permanent link")

You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:

`[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`

Then use the following prompt:

`` [](#%5F%5Fcodelineno-1-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-intercom` plugin in my project.
 ``

If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:

`[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-intercom
[](#%5F%5Fcodelineno-2-2)npx cap sync
`

This plugin requires an [Intercom](https://www.intercom.com/) account. You can find your **App ID** and the platform-specific **API keys** in the Intercom dashboard under **Settings → Installation**.

### Android[¶](#android "Permanent link")

#### Variables[¶](#variables "Permanent link")

This plugin will use the following project variables (defined in your app's `variables.gradle` file):

* `$intercomSdkVersion` version of `io.intercom.android:intercom-sdk-base` (default: `18.4.0`)

This plugin depends on `intercom-sdk-base` (not the full `intercom-sdk` artifact) on purpose. The full artifact ships its own `FirebaseMessagingService` and automatically integrates Firebase Cloud Messaging, which conflicts with apps that manage push notifications themselves (e.g. via [@capacitor-firebase/messaging](https://github.com/capawesome-team/capacitor-firebase)). The base artifact leaves push handling to you (see below).

#### Push Notifications[¶](#push-notifications "Permanent link")

Push notifications on Android are delivered through [Firebase Cloud Messaging (FCM)](https://firebase.google.com/docs/cloud-messaging). Because this plugin uses the base SDK, you forward the push token and incoming messages to Intercom from your JavaScript code. This is what makes the plugin coexist cleanly with [@capacitor-firebase/messaging](https://github.com/capawesome-team/capacitor-firebase):

`[](#%5F%5Fcodelineno-3-1)import { FirebaseMessaging } from '@capacitor-firebase/messaging';
[](#%5F%5Fcodelineno-3-2)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-3-3)
[](#%5F%5Fcodelineno-3-4)// Forward the FCM token to Intercom.
[](#%5F%5Fcodelineno-3-5)FirebaseMessaging.addListener('tokenReceived', async ({ token }) => {
[](#%5F%5Fcodelineno-3-6)  await Intercom.sendPushTokenToIntercom({ token });
[](#%5F%5Fcodelineno-3-7)});
[](#%5F%5Fcodelineno-3-8)
[](#%5F%5Fcodelineno-3-9)// Forward incoming messages to Intercom.
[](#%5F%5Fcodelineno-3-10)FirebaseMessaging.addListener('notificationReceived', async ({ notification }) => {
[](#%5F%5Fcodelineno-3-11)  const data = notification.data ?? {};
[](#%5F%5Fcodelineno-3-12)  const { intercom } = await Intercom.isIntercomPushNotification({ data });
[](#%5F%5Fcodelineno-3-13)  if (intercom) {
[](#%5F%5Fcodelineno-3-14)    await Intercom.handlePushNotification({ data });
[](#%5F%5Fcodelineno-3-15)  }
[](#%5F%5Fcodelineno-3-16)});
`

### iOS[¶](#ios "Permanent link")

The Intercom iOS SDK can be integrated via Swift Package Manager (recommended) or CocoaPods.

#### Info.plist[¶](#infoplist "Permanent link")

To manage push notifications yourself (and coexist with other push plugins), disable Intercom's automatic push integration by adding the following key to your `ios/App/App/Info.plist` file:

`[](#%5F%5Fcodelineno-4-1)<key>IntercomAutoIntegratePushNotifications</key>
[](#%5F%5Fcodelineno-4-2)<false/>
`

#### Push Notifications[¶](#push-notifications%5F1 "Permanent link")

Push notifications on iOS are delivered through [Apple Push Notification service (APNs)](https://developer.apple.com/documentation/usernotifications):

1. Enable the **Push Notifications** capability for your app target in Xcode.
2. Register for remote notifications (e.g. via [@capacitor-firebase/messaging](https://github.com/capawesome-team/capacitor-firebase) or `@capacitor/push-notifications`).
3. Forward the APNs device token to Intercom as a hexadecimal string:

`` [](#%5F%5Fcodelineno-5-1)import { PushNotifications } from '@capacitor/push-notifications';
[](#%5F%5Fcodelineno-5-2)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-5-3)
[](#%5F%5Fcodelineno-5-4)PushNotifications.addListener('registration', async ({ value }) => {
[](#%5F%5Fcodelineno-5-5)  // `value` is the hexadecimal APNs device token on iOS.
[](#%5F%5Fcodelineno-5-6)  await Intercom.sendPushTokenToIntercom({ token: value });
[](#%5F%5Fcodelineno-5-7)});
 ``

You can then check and handle incoming notifications the same way as on Android using `isIntercomPushNotification(...)` and `handlePushNotification(...)`.

### Web[¶](#web "Permanent link")

The web implementation loads the Intercom Messenger from Intercom's CDN at runtime. This requires an active network connection. If your app enforces a [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP), make sure to allow the Intercom domains (e.g. `https://widget.intercom.io`, `https://js.intercomcdn.com`, and `wss://*.intercom.io`).

> \[!NOTE\] On the web, the Intercom launcher is visible by default after `initialize(...)`, whereas on Android and iOS it is hidden until you present the Messenger. Use `setLauncherVisible({ visible: false })` on the web if you want to match the mobile behavior.

## Configuration[¶](#configuration "Permanent link")

No configuration required for this plugin.

## Usage[¶](#usage "Permanent link")

The following examples show how to use the plugin.

### Initialize the plugin[¶](#initialize-the-plugin "Permanent link")

Call `initialize(...)` once before all other methods:

`[](#%5F%5Fcodelineno-6-1)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-6-2)
[](#%5F%5Fcodelineno-6-3)const initialize = async () => {
[](#%5F%5Fcodelineno-6-4)  await Intercom.initialize({
[](#%5F%5Fcodelineno-6-5)    appId: 'YOUR_APP_ID',
[](#%5F%5Fcodelineno-6-6)    androidApiKey: 'YOUR_ANDROID_API_KEY',
[](#%5F%5Fcodelineno-6-7)    iosApiKey: 'YOUR_IOS_API_KEY',
[](#%5F%5Fcodelineno-6-8)  });
[](#%5F%5Fcodelineno-6-9)};
`

### Log in a user[¶](#log-in-a-user "Permanent link")

Log in an identified user, optionally with identity verification:

`[](#%5F%5Fcodelineno-7-1)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-7-2)
[](#%5F%5Fcodelineno-7-3)const loginUser = async () => {
[](#%5F%5Fcodelineno-7-4)  await Intercom.setUserHash({ userHash: 'YOUR_HMAC_HASH' });
[](#%5F%5Fcodelineno-7-5)  await Intercom.loginUser({
[](#%5F%5Fcodelineno-7-6)    userId: 'jane-doe',
[](#%5F%5Fcodelineno-7-7)    email: 'jane.doe@example.com',
[](#%5F%5Fcodelineno-7-8)  });
[](#%5F%5Fcodelineno-7-9)};
`

### Update the user[¶](#update-the-user "Permanent link")

Update the attributes of the current user:

`[](#%5F%5Fcodelineno-8-1)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-8-2)
[](#%5F%5Fcodelineno-8-3)const updateUser = async () => {
[](#%5F%5Fcodelineno-8-4)  await Intercom.updateUser({
[](#%5F%5Fcodelineno-8-5)    name: 'Jane Doe',
[](#%5F%5Fcodelineno-8-6)    customAttributes: { plan: 'pro' },
[](#%5F%5Fcodelineno-8-7)    companies: [{ id: 'capawesome', name: 'Capawesome', plan: 'enterprise' }],
[](#%5F%5Fcodelineno-8-8)  });
[](#%5F%5Fcodelineno-8-9)};
`

### Present the Messenger[¶](#present-the-messenger "Permanent link")

Present the Intercom Messenger or a specific piece of content:

`[](#%5F%5Fcodelineno-9-1)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-9-2)
[](#%5F%5Fcodelineno-9-3)const present = async () => {
[](#%5F%5Fcodelineno-9-4)  await Intercom.present({ space: 'home' });
[](#%5F%5Fcodelineno-9-5)};
[](#%5F%5Fcodelineno-9-6)
[](#%5F%5Fcodelineno-9-7)const presentArticle = async () => {
[](#%5F%5Fcodelineno-9-8)  await Intercom.presentContent({ type: 'article', id: '123456' });
[](#%5F%5Fcodelineno-9-9)};
`

### Listen for events[¶](#listen-for-events "Permanent link")

Listen for the unread conversation count:

`[](#%5F%5Fcodelineno-10-1)import { Intercom } from '@capawesome/capacitor-intercom';
[](#%5F%5Fcodelineno-10-2)
[](#%5F%5Fcodelineno-10-3)const addListeners = async () => {
[](#%5F%5Fcodelineno-10-4)  await Intercom.addListener('unreadConversationCountChange', ({ count }) => {
[](#%5F%5Fcodelineno-10-5)    console.log('Unread conversations:', count);
[](#%5F%5Fcodelineno-10-6)  });
[](#%5F%5Fcodelineno-10-7)};
`

## API[¶](#api "Permanent link")

* [getUnreadConversationCount()](#getunreadconversationcount)
* [handlePushNotification(...)](#handlepushnotification)
* [hide()](#hide)
* [initialize(...)](#initialize)
* [isIntercomPushNotification(...)](#isintercompushnotification)
* [logEvent(...)](#logevent)
* [loginUnidentifiedUser()](#loginunidentifieduser)
* [loginUser(...)](#loginuser)
* [logout()](#logout)
* [present(...)](#present)
* [presentContent(...)](#presentcontent)
* [presentMessageComposer(...)](#presentmessagecomposer)
* [sendPushTokenToIntercom(...)](#sendpushtokentointercom)
* [setBottomPadding(...)](#setbottompadding)
* [setInAppMessagesVisible(...)](#setinappmessagesvisible)
* [setLauncherVisible(...)](#setlaunchervisible)
* [setUserHash(...)](#setuserhash)
* [setUserJwt(...)](#setuserjwt)
* [updateUser(...)](#updateuser)
* [addListener('messengerHidden', ...)](#addlistenermessengerhidden-)
* [addListener('messengerShown', ...)](#addlistenermessengershown-)
* [addListener('unreadConversationCountChange', ...)](#addlistenerunreadconversationcountchange-)
* [removeAllListeners()](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)

### getUnreadConversationCount()[¶](#getunreadconversationcount "Permanent link")

`[](#%5F%5Fcodelineno-11-1)getUnreadConversationCount() => Promise<GetUnreadConversationCountResult>
`

Get the number of unread conversations for the current user.

**Returns:** `Promise<[GetUnreadConversationCountResult](#getunreadconversationcountresult)>`

**Since:** 0.1.0

---

### handlePushNotification(...)[¶](#handlepushnotification "Permanent link")

`[](#%5F%5Fcodelineno-12-1)handlePushNotification(options: HandlePushNotificationOptions) => Promise<void>
`

Handle an incoming push notification that belongs to Intercom.

Use `isIntercomPushNotification(...)` to check whether the notification belongs to Intercom before calling this method.

Only available on Android and iOS.

| Param       | Type                                                            |
| ----------- | --------------------------------------------------------------- |
| **options** | [HandlePushNotificationOptions](#handlepushnotificationoptions) |

**Since:** 0.1.0

---

### hide()[¶](#hide "Permanent link")

`[](#%5F%5Fcodelineno-13-1)hide() => Promise<void>
`

Hide any currently presented Intercom UI (e.g. the Messenger).

**Since:** 0.1.0

---

### initialize(...)[¶](#initialize "Permanent link")

`[](#%5F%5Fcodelineno-14-1)initialize(options: InitializeOptions) => Promise<void>
`

Initialize the Intercom SDK with your app ID and API key.

This method must be called before any other method.

| Param       | Type                                    |
| ----------- | --------------------------------------- |
| **options** | [InitializeOptions](#initializeoptions) |

**Since:** 0.1.0

---

### isIntercomPushNotification(...)[¶](#isintercompushnotification "Permanent link")

`[](#%5F%5Fcodelineno-15-1)isIntercomPushNotification(options: IsIntercomPushNotificationOptions) => Promise<IsIntercomPushNotificationResult>
`

Check whether an incoming push notification belongs to Intercom.

Only available on Android and iOS.

| Param       | Type                                                                    |
| ----------- | ----------------------------------------------------------------------- |
| **options** | [IsIntercomPushNotificationOptions](#isintercompushnotificationoptions) |

**Returns:** `Promise<[IsIntercomPushNotificationResult](#isintercompushnotificationresult)>`

**Since:** 0.1.0

---

### logEvent(...)[¶](#logevent "Permanent link")

`[](#%5F%5Fcodelineno-16-1)logEvent(options: LogEventOptions) => Promise<void>
`

Log an event with an optional set of metadata.

| Param       | Type                                |
| ----------- | ----------------------------------- |
| **options** | [LogEventOptions](#logeventoptions) |

**Since:** 0.1.0

---

### loginUnidentifiedUser()[¶](#loginunidentifieduser "Permanent link")

`[](#%5F%5Fcodelineno-17-1)loginUnidentifiedUser() => Promise<void>
`

Log in an unidentified (anonymous) user.

**Since:** 0.1.0

---

### loginUser(...)[¶](#loginuser "Permanent link")

`[](#%5F%5Fcodelineno-18-1)loginUser(options: LoginUserOptions) => Promise<void>
`

Log in an identified user with a user ID and/or an email address.

At least one of `userId` or `email` must be provided.

| Param       | Type                                  |
| ----------- | ------------------------------------- |
| **options** | [LoginUserOptions](#loginuseroptions) |

**Since:** 0.1.0

---

### logout()[¶](#logout "Permanent link")

`[](#%5F%5Fcodelineno-19-1)logout() => Promise<void>
`

Log out the current user and clear the local Intercom data.

**Since:** 0.1.0

---

### present(...)[¶](#present "Permanent link")

`[](#%5F%5Fcodelineno-20-1)present(options?: PresentOptions | undefined) => Promise<void>
`

Present the Intercom Messenger with the given space.

| Param       | Type                              |
| ----------- | --------------------------------- |
| **options** | [PresentOptions](#presentoptions) |

**Since:** 0.1.0

---

### presentContent(...)[¶](#presentcontent "Permanent link")

`[](#%5F%5Fcodelineno-21-1)presentContent(options: PresentContentOptions) => Promise<void>
`

Present a specific piece of Intercom content (e.g. an article, carousel, survey, or conversation).

| Param       | Type                                            |
| ----------- | ----------------------------------------------- |
| **options** | [PresentContentOptions](#presentcontentoptions) |

**Since:** 0.1.0

---

### presentMessageComposer(...)[¶](#presentmessagecomposer "Permanent link")

`[](#%5F%5Fcodelineno-22-1)presentMessageComposer(options?: PresentMessageComposerOptions | undefined) => Promise<void>
`

Present the Intercom message composer, optionally pre-filled with an initial message.

| Param       | Type                                                            |
| ----------- | --------------------------------------------------------------- |
| **options** | [PresentMessageComposerOptions](#presentmessagecomposeroptions) |

**Since:** 0.1.0

---

### sendPushTokenToIntercom(...)[¶](#sendpushtokentointercom "Permanent link")

`[](#%5F%5Fcodelineno-23-1)sendPushTokenToIntercom(options: SendPushTokenToIntercomOptions) => Promise<void>
`

Forward a push notification token to Intercom.

On Android, pass the Firebase Cloud Messaging (FCM) token. On iOS, pass the hexadecimal APNs device token.

| Param       | Type                                                              |
| ----------- | ----------------------------------------------------------------- |
| **options** | [SendPushTokenToIntercomOptions](#sendpushtokentointercomoptions) |

**Since:** 0.1.0

---

### setBottomPadding(...)[¶](#setbottompadding "Permanent link")

`[](#%5F%5Fcodelineno-24-1)setBottomPadding(options: SetBottomPaddingOptions) => Promise<void>
`

Set the bottom padding of the Intercom UI (in-app messages and launcher).

Only available on Android and iOS.

| Param       | Type                                                |
| ----------- | --------------------------------------------------- |
| **options** | [SetBottomPaddingOptions](#setbottompaddingoptions) |

**Since:** 0.1.0

---

### setInAppMessagesVisible(...)[¶](#setinappmessagesvisible "Permanent link")

`[](#%5F%5Fcodelineno-25-1)setInAppMessagesVisible(options: SetInAppMessagesVisibleOptions) => Promise<void>
`

Set whether in-app messages are visible.

| Param       | Type                                                              |
| ----------- | ----------------------------------------------------------------- |
| **options** | [SetInAppMessagesVisibleOptions](#setinappmessagesvisibleoptions) |

**Since:** 0.1.0

---

### setLauncherVisible(...)[¶](#setlaunchervisible "Permanent link")

`[](#%5F%5Fcodelineno-26-1)setLauncherVisible(options: SetLauncherVisibleOptions) => Promise<void>
`

Set whether the Intercom launcher is visible.

| Param       | Type                                                    |
| ----------- | ------------------------------------------------------- |
| **options** | [SetLauncherVisibleOptions](#setlaunchervisibleoptions) |

**Since:** 0.1.0

---

### setUserHash(...)[¶](#setuserhash "Permanent link")

`[](#%5F%5Fcodelineno-27-1)setUserHash(options: SetUserHashOptions) => Promise<void>
`

Set the user hash (HMAC) for identity verification.

This must be called before logging in the user.

| Param       | Type                                      |
| ----------- | ----------------------------------------- |
| **options** | [SetUserHashOptions](#setuserhashoptions) |

**Since:** 0.1.0

---

### setUserJwt(...)[¶](#setuserjwt "Permanent link")

`[](#%5F%5Fcodelineno-28-1)setUserJwt(options: SetUserJwtOptions) => Promise<void>
`

Set the JSON Web Token (JWT) for identity verification.

This must be called before logging in the user.

| Param       | Type                                    |
| ----------- | --------------------------------------- |
| **options** | [SetUserJwtOptions](#setuserjwtoptions) |

**Since:** 0.1.0

---

### updateUser(...)[¶](#updateuser "Permanent link")

`[](#%5F%5Fcodelineno-29-1)updateUser(options: UpdateUserOptions) => Promise<void>
`

Update the attributes of the current user.

| Param       | Type                                    |
| ----------- | --------------------------------------- |
| **options** | [UpdateUserOptions](#updateuseroptions) |

**Since:** 0.1.0

---

### addListener('messengerHidden', ...)[¶](#addlistenermessengerhidden "Permanent link")

`[](#%5F%5Fcodelineno-30-1)addListener(eventName: 'messengerHidden', listenerFunc: () => void) => Promise<PluginListenerHandle>
`

Called when the Intercom Messenger is hidden.

Only available on iOS and Web.

| Param            | Type              |
| ---------------- | ----------------- |
| **eventName**    | 'messengerHidden' |
| **listenerFunc** | () => void        |

**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`

**Since:** 0.1.0

---

### addListener('messengerShown', ...)[¶](#addlistenermessengershown "Permanent link")

`[](#%5F%5Fcodelineno-31-1)addListener(eventName: 'messengerShown', listenerFunc: () => void) => Promise<PluginListenerHandle>
`

Called when the Intercom Messenger is shown.

Only available on iOS and Web.

| Param            | Type             |
| ---------------- | ---------------- |
| **eventName**    | 'messengerShown' |
| **listenerFunc** | () => void       |

**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`

**Since:** 0.1.0

---

### addListener('unreadConversationCountChange', ...)[¶](#addlistenerunreadconversationcountchange "Permanent link")

`[](#%5F%5Fcodelineno-32-1)addListener(eventName: 'unreadConversationCountChange', listenerFunc: (event: UnreadConversationCountChangeEvent) => void) => Promise<PluginListenerHandle>
`

Called when the number of unread conversations changes.

| Param            | Type                                                                                       |
| ---------------- | ------------------------------------------------------------------------------------------ |
| **eventName**    | 'unreadConversationCountChange'                                                            |
| **listenerFunc** | (event: [UnreadConversationCountChangeEvent](#unreadconversationcountchangeevent)) => void |

**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`

**Since:** 0.1.0

---

### removeAllListeners()[¶](#removealllisteners "Permanent link")

`[](#%5F%5Fcodelineno-33-1)removeAllListeners() => Promise<void>
`

Remove all listeners for this plugin.

**Since:** 0.1.0

---

### Interfaces[¶](#interfaces "Permanent link")

#### GetUnreadConversationCountResult[¶](#getunreadconversationcountresult "Permanent link")

| Prop      | Type   | Description                         | Since |
| --------- | ------ | ----------------------------------- | ----- |
| **count** | number | The number of unread conversations. | 0.1.0 |

#### HandlePushNotificationOptions[¶](#handlepushnotificationoptions "Permanent link")

| Prop     | Type                    | Description                        | Since |
| -------- | ----------------------- | ---------------------------------- | ----- |
| **data** | Record<string, unknown> | The data of the push notification. | 0.1.0 |

#### InitializeOptions[¶](#initializeoptions "Permanent link")

| Prop              | Type   | Description                                                                      | Since |
| ----------------- | ------ | -------------------------------------------------------------------------------- | ----- |
| **androidApiKey** | string | The Android API key of your Intercom app. Required to use the plugin on Android. | 0.1.0 |
| **appId**         | string | The app ID of your Intercom app.                                                 | 0.1.0 |
| **iosApiKey**     | string | The iOS API key of your Intercom app. Required to use the plugin on iOS.         | 0.1.0 |

#### IsIntercomPushNotificationResult[¶](#isintercompushnotificationresult "Permanent link")

| Prop         | Type    | Description                                        | Since |
| ------------ | ------- | -------------------------------------------------- | ----- |
| **intercom** | boolean | Whether the push notification belongs to Intercom. | 0.1.0 |

#### IsIntercomPushNotificationOptions[¶](#isintercompushnotificationoptions "Permanent link")

| Prop     | Type                    | Description                        | Since |
| -------- | ----------------------- | ---------------------------------- | ----- |
| **data** | Record<string, unknown> | The data of the push notification. | 0.1.0 |

#### LogEventOptions[¶](#logeventoptions "Permanent link")

| Prop     | Type                            | Description            | Since                      |       |
| -------- | ------------------------------- | ---------------------- | -------------------------- | ----- |
| **data** | Record<string, string \| number | boolean>               | The metadata of the event. | 0.1.0 |
| **name** | string                          | The name of the event. | 0.1.0                      |       |

#### LoginUserOptions[¶](#loginuseroptions "Permanent link")

| Prop       | Type   | Description                        | Since |
| ---------- | ------ | ---------------------------------- | ----- |
| **email**  | string | The email address of the user.     | 0.1.0 |
| **userId** | string | The unique identifier of the user. | 0.1.0 |

#### PresentOptions[¶](#presentoptions "Permanent link")

| Prop      | Type                            | Description           | Default | Since |
| --------- | ------------------------------- | --------------------- | ------- | ----- |
| **space** | [IntercomSpace](#intercomspace) | The space to present. | 'home'  | 0.1.0 |

#### PresentContentOptions[¶](#presentcontentoptions "Permanent link")

| Prop     | Type                                        | Description                                                                                                           | Since |
| -------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ----- |
| **id**   | string                                      | The identifier of the content to present. Required for the article, carousel, survey, and conversation content types. | 0.1.0 |
| **ids**  | string\[\]                                  | The identifiers of the content to present. Required for the help-center-collections content type.                     | 0.1.0 |
| **type** | [IntercomContentType](#intercomcontenttype) | The type of content to present.                                                                                       | 0.1.0 |

#### PresentMessageComposerOptions[¶](#presentmessagecomposeroptions "Permanent link")

| Prop               | Type   | Description                                | Since |
| ------------------ | ------ | ------------------------------------------ | ----- |
| **initialMessage** | string | The message to pre-fill the composer with. | 0.1.0 |

#### SendPushTokenToIntercomOptions[¶](#sendpushtokentointercomoptions "Permanent link")

| Prop      | Type   | Description                                                                                                                                   | Since |
| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **token** | string | The push notification token. On Android, this is the Firebase Cloud Messaging (FCM) token. On iOS, this is the hexadecimal APNs device token. | 0.1.0 |

#### SetBottomPaddingOptions[¶](#setbottompaddingoptions "Permanent link")

| Prop        | Type   | Description                | Since |
| ----------- | ------ | -------------------------- | ----- |
| **padding** | number | The bottom padding to set. | 0.1.0 |

#### SetInAppMessagesVisibleOptions[¶](#setinappmessagesvisibleoptions "Permanent link")

| Prop        | Type    | Description                                | Since |
| ----------- | ------- | ------------------------------------------ | ----- |
| **visible** | boolean | Whether in-app messages should be visible. | 0.1.0 |

#### SetLauncherVisibleOptions[¶](#setlaunchervisibleoptions "Permanent link")

| Prop        | Type    | Description                             | Since |
| ----------- | ------- | --------------------------------------- | ----- |
| **visible** | boolean | Whether the launcher should be visible. | 0.1.0 |

#### SetUserHashOptions[¶](#setuserhashoptions "Permanent link")

| Prop         | Type   | Description                                                                                                                                                         | Since |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **userHash** | string | The user hash (HMAC) for identity verification. The hash must be generated on your backend using your Intercom secret key. Never expose the secret key in your app. | 0.1.0 |

#### SetUserJwtOptions[¶](#setuserjwtoptions "Permanent link")

| Prop    | Type   | Description                                                                                                                                                              | Since |
| ------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **jwt** | string | The JSON Web Token (JWT) for identity verification. The token must be generated on your backend using your Intercom secret key. Never expose the secret key in your app. | 0.1.0 |

#### UpdateUserOptions[¶](#updateuseroptions "Permanent link")

| Prop                       | Type                            | Description                                                 | Since                              |       |
| -------------------------- | ------------------------------- | ----------------------------------------------------------- | ---------------------------------- | ----- |
| **companies**              | UpdateUserCompany\[\]           | The companies the user belongs to.                          | 0.1.0                              |       |
| **customAttributes**       | Record<string, string \| number | boolean>                                                    | The custom attributes of the user. | 0.1.0 |
| **email**                  | string                          | The email address of the user.                              | 0.1.0                              |       |
| **languageOverride**       | string                          | The preferred language of the user as an ISO 639-1 code.    | 0.1.0                              |       |
| **name**                   | string                          | The name of the user.                                       | 0.1.0                              |       |
| **phone**                  | string                          | The phone number of the user.                               | 0.1.0                              |       |
| **signedUpAt**             | number                          | The date the user signed up as a Unix timestamp in seconds. | 0.1.0                              |       |
| **unsubscribedFromEmails** | boolean                         | Whether the user is unsubscribed from emails.               | 0.1.0                              |       |
| **userId**                 | string                          | The unique identifier of the user.                          | 0.1.0                              |       |

#### UpdateUserCompany[¶](#updateusercompany "Permanent link")

| Prop                 | Type                            | Description                                                      | Since                                 |       |
| -------------------- | ------------------------------- | ---------------------------------------------------------------- | ------------------------------------- | ----- |
| **createdAt**        | number                          | The date the company was created as a Unix timestamp in seconds. | 0.1.0                                 |       |
| **customAttributes** | Record<string, string \| number | boolean>                                                         | The custom attributes of the company. | 0.1.0 |
| **id**               | string                          | The unique identifier of the company.                            | 0.1.0                                 |       |
| **monthlySpend**     | number                          | The monthly spend of the company.                                | 0.1.0                                 |       |
| **name**             | string                          | The name of the company.                                         | 0.1.0                                 |       |
| **plan**             | string                          | The plan of the company.                                         | 0.1.0                                 |       |

#### PluginListenerHandle[¶](#pluginlistenerhandle "Permanent link")

| Prop       | Type                |
| ---------- | ------------------- |
| **remove** | () => Promise<void> |

#### UnreadConversationCountChangeEvent[¶](#unreadconversationcountchangeevent "Permanent link")

| Prop      | Type   | Description                         | Since |
| --------- | ------ | ----------------------------------- | ----- |
| **count** | number | The number of unread conversations. | 0.1.0 |

### Type Aliases[¶](#type-aliases "Permanent link")

#### IntercomSpace[¶](#intercomspace "Permanent link")

A space of the Intercom Messenger.

`'home' | 'messages' | 'help-center' | 'tickets'`

#### IntercomContentType[¶](#intercomcontenttype "Permanent link")

A type of Intercom content that can be presented.

`'article' | 'carousel' | 'conversation' | 'help-center-collections' | 'survey'`

## Migration[¶](#migration "Permanent link")

If you are migrating from [@capacitor-community/intercom](https://github.com/capacitor-community/intercom) or another Intercom plugin, note that this plugin uses the **modern** Intercom API names throughout. The deprecated `register*` login methods are intentionally not exposed. The following table maps common legacy method names to their modern equivalents:

| Legacy method             | This plugin                       |
| ------------------------- | --------------------------------- |
| registerIdentifiedUser    | loginUser                         |
| registerUnidentifiedUser  | loginUnidentifiedUser             |
| logout                    | logout                            |
| displayMessenger          | present                           |
| displayMessageComposer    | presentMessageComposer            |
| displayArticle            | presentContent                    |
| displayCarousel           | presentContent                    |
| displayHelpCenter         | present({ space: 'help-center' }) |
| hideMessenger             | hide                              |
| unreadConversationCount   | getUnreadConversationCount        |
| setLauncherVisibility     | setLauncherVisible                |
| setInAppMessageVisibility | setInAppMessagesVisible           |
| sendPushTokenToIntercom   | sendPushTokenToIntercom           |

## Platform Support[¶](#platform-support "Permanent link")

Not every Intercom SDK feature is available on all platforms. The following table lists the notable per-platform differences of the plugin's API:

| Method / Event                                | Android | iOS | Web |
| --------------------------------------------- | ------- | --- | --- |
| handlePushNotification(...)                   | ✅       | ✅   | ❌   |
| isIntercomPushNotification(...)               | ✅       | ✅   | ❌   |
| presentContent(...) (carousel)                | ✅       | ✅   | ❌   |
| presentContent(...) (help-center-collections) | ✅       | ✅   | ❌   |
| sendPushTokenToIntercom(...)                  | ✅       | ✅   | ❌   |
| setBottomPadding(...)                         | ✅       | ✅   | ❌   |
| messengerShown / messengerHidden events       | ❌       | ✅   | ✅   |

Additional notes:

* On the web, `getUnreadConversationCount(...)` returns the last value received from the change event, since the web SDK exposes the count only through a callback.
* The `messengerShown` and `messengerHidden` events are not available on Android because the Intercom Android SDK does not expose a window visibility hook.
* `setBottomPadding(...)` uses pixels on Android and points on iOS, matching the respective native SDK.

## Licensing[¶](#licensing "Permanent link")

The Intercom Android and iOS SDKs are licensed under the Apache License 2.0 and are distributed via Maven Central, CocoaPods, and Swift Package Manager. The web SDK is licensed under the MIT license. This plugin only declares these SDKs as dependencies and does not bundle or modify them. Using the plugin requires an active Intercom account. The MIT license of this plugin covers the wrapper code only, not the Intercom SDKs.

## FAQ[¶](#faq "Permanent link")

### Do I need an Intercom account to use this plugin?[¶](#do-i-need-an-intercom-account-to-use-this-plugin "Permanent link")

Yes. This plugin wraps the official Intercom SDKs, which require an active [Intercom](https://www.intercom.com/) account, an app ID, and platform-specific API keys.

### How is this plugin different from other similar plugins?[¶](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link")

This plugin uses Intercom's modern login APIs (`loginUnidentifiedUser(...)` and `loginUser(...)`). On Android it depends on the base SDK, so it coexists cleanly with your own Firebase Cloud Messaging or APNs setup and lets you forward push notifications to Intercom yourself. It also ships a fully typed web implementation, cross-platform push notification helpers, and is backed by dedicated support.

### Why does this plugin use `intercom-sdk-base` instead of `intercom-sdk` on Android?[¶](#why-does-this-plugin-use-intercom-sdk-base-instead-of-intercom-sdk-on-android "Permanent link")

The full `intercom-sdk` artifact automatically integrates Firebase Cloud Messaging by registering its own `FirebaseMessagingService`. This conflicts with apps that manage push notifications themselves (e.g. via `@capacitor-firebase/messaging`). The base artifact avoids this conflict and lets you forward push notifications to Intercom yourself.

### How does identity verification work?[¶](#how-does-identity-verification-work "Permanent link")

Generate a user hash (HMAC) or a JSON Web Token (JWT) on your backend using your Intercom secret key, then pass it via `setUserHash(...)` or `setUserJwt(...)` **before** logging in the user. Never expose your secret key in your app.

### Can I use this plugin with Ionic, React, Vue or Angular?[¶](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link")

Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.

## Newsletter[¶](#newsletter "Permanent link")

Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).

## Changelog[¶](#changelog "Permanent link")

See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/intercom/CHANGELOG.md).

## License[¶](#license "Permanent link")

See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/intercom/LICENSE).

---

1. This project is not affiliated with, endorsed by, sponsored by, or approved by Intercom Inc. or any of its affiliates or subsidiaries. "Intercom" is a trademark of Intercom Inc. [↩](#fnref:1 "Jump back to footnote 1 in the text")

July 13, 2026 

Back to top

```json
{"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/intercom/#article", "headline": "Capacitor Intercom Plugin for Android, iOS & Web", "name": "Capacitor Intercom Plugin for Android, iOS & Web", "description": "Unofficial Capacitor plugin for Intercom to integrate the Intercom Messenger on Android, iOS, and Web with identity verification and push notifications.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/intercom/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/intercom/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/intercom/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/intercom/#software", "name": "Capacitor Intercom Plugin for Android, iOS & Web", "description": "Unofficial Capacitor plugin for Intercom to integrate the Intercom Messenger on Android, iOS, and Web with identity verification and push notifications.", "url": "https://capawesome.io/docs/sdks/capacitor/intercom/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]}
{"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "Do I need an Intercom account to use this plugin?", "acceptedAnswer": {"@type": "Answer", "text": "Yes. This plugin wraps the official Intercom SDKs, which require an active Intercom account, an app ID, and platform-specific API keys."}}, {"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "This plugin uses Intercom's modern login APIs ( loginUnidentifiedUser(...) and loginUser(...)). On Android it depends on the base SDK, so it coexists cleanly with your own Firebase Cloud Messaging or APNs setup and lets you forward push notifications to Intercom yourself. It also ships a fully typed web implementation, cross-platform push notification helpers, and is backed by dedicated support."}}, {"@type": "Question", "name": "Why does this plugin use intercom-sdk-base instead of intercom-sdk on Android?", "acceptedAnswer": {"@type": "Answer", "text": "The full intercom-sdk artifact automatically integrates Firebase Cloud Messaging by registering its own FirebaseMessagingService. This conflicts with apps that manage push notifications themselves (e.g. via @capacitor-firebase/messaging). The base artifact avoids this conflict and lets you forward push notifications to Intercom yourself."}}, {"@type": "Question", "name": "How does identity verification work?", "acceptedAnswer": {"@type": "Answer", "text": "Generate a user hash (HMAC) or a JSON Web Token (JWT) on your backend using your Intercom secret key, then pass it via setUserHash(...) or setUserJwt(...) before logging in the user. Never expose your secret key in your app."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/intercom/"}
```
