@capacitor-community/intercom

Capacitor Intercom

@capacitor-community/intercom

Capacitor community plugin for enabling Intercom capabilities

Maintainers

| Maintainer | GitHub | Social |
| ------------ | --------------------------------------- | ----------------------------------- |
| Stewan Silva | stewones | @stewones |

Compatibility

| Capacitor | Intercom iOS | Intercom Android | iOS Target | Android Target |
| --------- | ------------ | ---------------- | ---------- | -------------- |
| 7.x | 18.x | 15.x | 15.0 | 35 |
| 6.x | 16.x | 12.x | 13.0 | 34 |

> Note: This plugin follows semantic versioning aligned with Capacitor and maintains compatibility with Intercom SDKs (iOS, Android). If you encounter any issues due to versioning inconsistencies, please open an issue to help us improve the plugin.

Installation

Using npm:

``bash
npm install @capacitor-community/intercom
`

Using yarn:

`bash
yarn add @capacitor-community/intercom
`

Sync native files:

`bash
npx cap sync
`

Usage

`js
import { Intercom } from '@capacitor-community/intercom';
import { PushNotifications } from '@capacitor/push-notifications';

// Register for push notifications from Intercom
PushNotifications.register();

// Register an indetified user
Intercom.registerIdentifiedUser({ userId: 123456 });
Intercom.registerIdentifiedUser({ email: 'test@example.com' });
Intercom.registerIdentifiedUser({ userId: 123456, email: 'test@example.com' });

// Register a log event
Intercom.logEvent({ name: 'my-event', data: { pi: 3.14 } });

// Display the message composer
Intercom.displayMessageComposer({ message: 'Hello there!' });

// Identity Verification
// https://developers.intercom.com/installing-intercom/docs/ios-identity-verification
Intercom.setUserHash({ hmac: 'xyz' });

// Secure Your Messenger
// https://developers.intercom.com/installing-intercom/ios/secure-your-messenger
Intercom.setUserJwt({ jwt: 'xyz' });
`

iOS setup

- ionic start my-cap-app --capacitor
- cd my-cap-app
- npm install —-save @capacitor-community/intercom
- mkdir www && touch www/index.html
- npx cap add ios
- add intercom keys to capacitor's configuration file

`
{
…
"plugins": {
"Intercom": {
"iosApiKey": "ios_sdk-xxx",
"iosAppId": "yyy"
}
}
…
}
`

- npx cap open ios
- sign your app at xcode (general tab)

> Tip: every time you change a native code you may need to clean up the cache (Product > Clean build folder) and then run the app again.

Android setup

- ionic start my-cap-app --capacitor
- cd my-cap-app
- npm install —-save @capacitor-community/intercom
- mkdir www && touch www/index.html
- npx cap add android
- add intercom keys to capacitor's configuration file

`
{
…
"plugins": {
"Intercom": {
"androidApiKey": "android_sdk-xxx",
"androidAppId": "yyy"
}
}
…
}
`

- npx cap open android

Now you should be set to go. Try to run your client using ionic cap run android --livereload.

> Tip: every time you change a native code you may need to clean up the cache (Build > Clean Project | Build > Rebuild Project) and then run the app again.

API

* loadWithKeys(...)
* registerIdentifiedUser(...)
* registerUnidentifiedUser()
* updateUser(...)
* logout()
* logEvent(...)
* displayMessenger()
* displayMessageComposer(...)
* displayHelpCenter()
* hideMessenger()
* displayLauncher()
* hideLauncher()
* displayInAppMessages()
* hideInAppMessages()
* displayCarousel(...)
* setUserHash(...)
* setUserJwt(...)
* setBottomPadding(...)
* sendPushTokenToIntercom(...)
* receivePush(...)
* displayArticle(...)
* addListener('windowDidShow', ...)
* addListener('windowDidHide', ...)
* removeAllListeners()
* Interfaces

$3

`typescript
loadWithKeys(options: { appId?: string; apiKeyIOS?: string; apiKeyAndroid?: string; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------------------------------------------------- |
| options | { appId?: string; apiKeyIOS?: string; apiKeyAndroid?: string; } |

--------------------

$3

`typescript
registerIdentifiedUser(options: { userId?: string; email?: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------------- |
| options | { userId?: string; email?: string; } |

--------------------

$3

`typescript
registerUnidentifiedUser() => Promise
`

--------------------

$3

`typescript
updateUser(options: IntercomUserUpdateOptions) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------------------------------------------- |
| options | IntercomUserUpdateOptions |

--------------------

$3

`typescript
logout() => Promise
`

--------------------

$3

`typescript
logEvent(options: { name: string; data?: any; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------ |
| options | { name: string; data?: any; } |

--------------------

$3

`typescript
displayMessenger() => Promise
`

--------------------

$3

`typescript
displayMessageComposer(options: { message: string; }) => Promise
`

| Param | Type |
| ------------- | --------------------------------- |
| options | { message: string; } |

--------------------

$3

`typescript
displayHelpCenter() => Promise
`

--------------------

$3

`typescript
hideMessenger() => Promise
`

--------------------

$3

`typescript
displayLauncher() => Promise
`

--------------------

$3

`typescript
hideLauncher() => Promise
`

--------------------

$3

`typescript
displayInAppMessages() => Promise
`

--------------------

$3

`typescript
hideInAppMessages() => Promise
`

--------------------

$3

`typescript
displayCarousel(options: { carouselId: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------------ |
| options | { carouselId: string; } |

--------------------

$3

`typescript
setUserHash(options: { hmac: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------ |
| options | { hmac: string; } |

--------------------

$3

`typescript
setUserJwt(options: { jwt: string; }) => Promise
`

| Param | Type |
| ------------- | ----------------------------- |
| options | { jwt: string; } |

--------------------

$3

`typescript
setBottomPadding(options: { value: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------- |
| options | { value: string; } |

--------------------

$3

`typescript
sendPushTokenToIntercom(options: { value: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------- |
| options | { value: string; } |

--------------------

$3

`typescript
receivePush(notification: IntercomPushNotificationData) => Promise
`

| Param | Type |
| ------------------ | ------------------------------------------------------------------------------------- |
| notification | IntercomPushNotificationData |

--------------------

$3

`typescript
displayArticle(options: { articleId: string; }) => Promise
`

| Param | Type |
| ------------- | ----------------------------------- |
| options | { articleId: string; } |

--------------------

$3

`typescript
addListener(eventName: 'windowDidShow', listenerFunc: () => void) => Promise
`

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

Returns: Promise<PluginListenerHandle>

--------------------

$3

`typescript
addListener(eventName: 'windowDidHide', listenerFunc: () => void) => Promise
`

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

Returns: Promise<PluginListenerHandle>

--------------------

$3

`typescript
removeAllListeners() => Promise
`

--------------------

$3


#### IntercomUserUpdateOptions

| Prop | Type |
| ---------------------- | ------------------------------------ |
| userId | string |
| email | string |
| name | string |
| phone | string |
| languageOverride | string |
| customAttributes | { [key: string]: any; } |


#### IntercomPushNotificationData

| Prop | Type |
| ------------------------------- | ------------------- |
| conversation_id | string |
| message | string |
| body | string |
| author_name | string |
| image_url | string |
| app_name | string |
| receiver | string |
| conversation_part_type | string |
| intercom_push_type | string |
| uri | string |
| push_only_conversation_id | string |
| instance_id | string |
| title | string |
| priority | number |


#### PluginListenerHandle

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

Notice 🚀

We're starting fresh under an official org. If you were using the previous npm package capacitor-intercom, please update your package.json to @capacitor-community/intercom. Check out changelog for more info.

Breaking changes from Capacitor v2 to v3

- UserUpdateOptions option type becomes IntercomUserUpdateOptions
- IntercomPlugin configuration key becomes Intercom
- android-apiKey config key becomes androidApiKey
- android-appId config key becomes androidAppId
- ios-apiKey config key becomes iosApiKey
- ios-appId config key becomes iosAppId
- Switch from CAPBridge to ApplicationDelegateProxy in application events
- remove the whole onCreate initialization from your app's MainActivity.java

`diff
public class MainActivity extends BridgeActivity {
- @Override
- public void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
-
- // Initializes the Bridge
- this.init(savedInstanceState, new ArrayList>() {{
- // Additional plugins you've installed go here
- add(IntercomPlugin.class);
- }});
- }
}
``

License

MIT

Example

- https://github.com/capacitor-community/intercom/blob/master/example

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Stew 💻 📖	David Seek 💻	Roman Nikitin 💻	Anne Tomassoni 💻 👀	Maciej Modzelewski 💻	Oleg Yuzvik 🚧	Gustavo Corrêa Alves 📖
Jealvia 🚧	Adam Duren 💻 🚧	Rami Khafagi 💻	Masahiko Sakakibara 🚧	Dejardin Camille 💻	Mohamed Abdelgwad 🚧	Nathan 🚧
Cecil Wöbker 💻 🚧	Pavlo Pyrig 💻	Ruan 💻	RickJeroen 🚧	reslear 📖	Philipp Matter 💻	Josh Pike 🚧
vtorenaintermedia 💻

This project follows the all-contributors specification. Contributions of any kind welcome!