Skip to main content
@capgo/capacitor-crisp Communication Open source

Crisp Capacitor plugin

Integrate Crisp live chat and customer support directly into your mobile app

Install

bun add @capgo/capacitor-crisp bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-crisp
  • pnpm add @capgo/capacitor-crisp
  • yarn add @capgo/capacitor-crisp

Guide

How to use Crisp in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

App Store Google Play
Crisp plugin preview QR code

Using @capgo/capacitor-crisp

Crisp Chat SDK Plugin for Capacitor. Provides live chat and customer support functionality through Crisp.chat.

Install

bun add @capgo/capacitor-crisp
bunx cap sync

What This Plugin Exposes

  • configure - Configure the Crisp SDK with your website ID. Must be called before using any other methods.
  • openMessenger - Open the Crisp messenger chat window. Shows the chat interface to the user.
  • setTokenID - Set a unique token ID for the current user session. Used to identify and restore previous conversations.
  • setUser - Set user information for the current session. Updates the user profile visible to support agents.

Example Usage

configure

Configure the Crisp SDK with your website ID. Must be called before using any other methods.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.configure({ websiteID: 'YOUR_WEBSITE_ID' });

openMessenger

Open the Crisp messenger chat window. Shows the chat interface to the user.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.openMessenger();

setTokenID

Set a unique token ID for the current user session. Used to identify and restore previous conversations.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.setTokenID({ tokenID: 'token-id-123' });

setUser

Set user information for the current session. Updates the user profile visible to support agents.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.setUser({
  nickname: 'John Doe',
  email: 'john@example.com',
  phone: '+1234567890'
});

Full Reference

Keep going from Using @capgo/capacitor-crisp

If you are using Using @capgo/capacitor-crisp to plan migration and enterprise operations, connect it with @capgo/capacitor-crisp for the implementation detail in @capgo/capacitor-crisp, Getting Started for the implementation detail in Getting Started, Capgo Enterprise for the product workflow in Capgo Enterprise, Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives, and Capgo Alternatives for the product workflow in Capgo Alternatives.

FAQ

Crisp plugin FAQ

How do I install the Crisp plugin in a Capacitor app?

Run "bun add @capgo/capacitor-crisp" (or "npm install @capgo/capacitor-crisp"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-crisp" in your app code.

Does @capgo/capacitor-crisp work with React, Vue and Angular?

Yes. Crisp is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-crisp support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-crisp free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-crisp/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Crisp without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Communication

Related plugins

Browse all plugins →

Ship Crisp changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo