Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-intercom
Tutorial
by github.com/Cap-go

Intercom

Integrate Intercom live chat, help center, and support workflows in your Capacitor app

Downloads/week

8.5k

GitHub Stars

2

Guide

Tutorial on Intercom

Using @capgo/capacitor-intercom

Intercom Capacitor plugin.

Install

bun add @capgo/capacitor-intercom
bunx cap sync

What This Plugin Exposes

  • loadWithKeys - Initialize Intercom with API keys at runtime. Use this if you prefer not to configure keys in capacitor.config.
  • registerIdentifiedUser - Register a known user with Intercom. At least one of userId or email must be provided.
  • registerUnidentifiedUser - Register an anonymous user with Intercom.
  • updateUser - Update user attributes in Intercom.

Example Usage

loadWithKeys

Initialize Intercom with API keys at runtime. Use this if you prefer not to configure keys in capacitor.config.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.loadWithKeys({} as IntercomLoadOptions);

registerIdentifiedUser

Register a known user with Intercom. At least one of userId or email must be provided.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerIdentifiedUser({} as IntercomIdentifiedUserOptions);

registerUnidentifiedUser

Register an anonymous user with Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerUnidentifiedUser();

updateUser

Update user attributes in Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.updateUser({} as IntercomUserUpdateOptions);

Full Reference

Keep going from Using @capgo/capacitor-intercom

If you are using Using @capgo/capacitor-intercom to plan native plugin work, connect it with @capgo/capacitor-intercom for the implementation detail in @capgo/capacitor-intercom, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.