---
description: Unofficial Capacitor plugin for Crisp to add the Crisp chat SDK to your app on Android, iOS, and Web with chatbox, helpdesk, and push notifications.
title: Capacitor Crisp Plugin for Android, iOS & Web - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/crisp.png
---
[Skip to content ](#capacitor-crisp-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/)
* [ iOS ](#ios)
* [ Web ](#web)
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Platform Support ](#platform-support)
* [ Licensing ](#licensing)
* [ FAQ ](#faq)
* [ Newsletter ](#newsletter)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Datetime Picker ](/docs/sdks/capacitor/datetime-picker/)
* [ Device Info ](/docs/sdks/capacitor/device-info/)
* [ Dialog ](/docs/sdks/capacitor/dialog/)
* [ Exif ](/docs/sdks/capacitor/exif/)
* [ Facebook Sign-In ](/docs/sdks/capacitor/facebook-sign-in/)
* [ File Compressor ](/docs/sdks/capacitor/file-compressor/)
* [ File Opener ](/docs/sdks/capacitor/file-opener/)
* [ File Picker ](/docs/sdks/capacitor/file-picker/)
* [ Firebase ](/docs/sdks/capacitor/firebase/)
* [ 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 ](/docs/sdks/capacitor/intercom/)
* [ 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)
* [ Enums ](#enums)
* [ Platform Support ](#platform-support)
* [ Licensing ](#licensing)
* [ FAQ ](#faq)
* [ Newsletter ](#newsletter)
* [ Changelog ](#changelog)
* [ License ](#license)
# Capacitor Crisp Plugin[ΒΆ](#capacitor-crisp-plugin "Permanent link")
Unofficial Capacitor plugin for [Crisp](https://crisp.chat/).[1](#fn:1)
[  ](https://cloud.capawesome.io/)
## Features[ΒΆ](#features "Permanent link")
The Capacitor Crisp plugin is a comprehensive integration of the Crisp chat SDKs for Capacitor apps. Here are some of the key features:
* π₯οΈ **Cross-platform**: Supports Android, iOS, and Web.
* π¬ **Chatbox**: Open the Crisp chatbox with a single method call.
* π€ **User Identity**: Set the user's email, nickname, phone number, avatar, and company.
* π **Identity Verification**: Verify the user's identity with an HMAC-SHA256 email signature.
* 𧩠**Session Data**: Attach custom data, segments, and events to the session.
* π **Helpdesk**: Open the helpdesk search or a specific helpdesk article.
* π **Push Notifications**: Interoperate with Firebase Cloud Messaging (Android) and APNs (iOS).
* π‘ **Typed Events**: Listen for chat, message, and session events with typed listeners.
* π **Typed Web SDK**: Uses the official `crisp-sdk-web` package on the web.
* π¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.
* π **Up-to-date**: Always supports the latest Capacitor version.
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 Crisp 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 email, name, and company to every conversation.
* **Self-service**: Point users to helpdesk articles without leaving the app.
* **Contextual data**: Enrich conversations with session data, segments, and events based on user behavior.
* **Re-engagement**: Notify users about new operator 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-crisp` 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-crisp
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
This plugin requires a [Crisp](https://crisp.chat/) account. You can find your **Website ID** in the Crisp dashboard under **Settings β Website Settings β Setup & Integrations**.
### Android[ΒΆ](#android "Permanent link")
#### Variables[ΒΆ](#variables "Permanent link")
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
* `$crispSdkVersion` version of `im.crisp:crisp-sdk` (default: `2.0.22`)
* `$firebaseMessagingVersion` version of `com.google.firebase:firebase-messaging` (default: `24.1.1`)
#### Minimum SDK Version[ΒΆ](#minimum-sdk-version "Permanent link")
The Crisp Android SDK requires a minimum SDK version of `24`. Make sure the `minSdkVersion` in your app's `variables.gradle` file is set to `24` or higher.
#### Multidex[ΒΆ](#multidex "Permanent link")
The Crisp Android SDK requires [multidex](https://developer.android.com/build/multidex) to be enabled. Enable it in your app's `android/app/build.gradle` file:
`[](#%5F%5Fcodelineno-3-1)android {
[](#%5F%5Fcodelineno-3-2) defaultConfig {
[](#%5F%5Fcodelineno-3-3) multiDexEnabled true
[](#%5F%5Fcodelineno-3-4) }
[](#%5F%5Fcodelineno-3-5)}
`
#### FileProvider[ΒΆ](#fileprovider "Permanent link")
The Crisp Android SDK ships its own `FileProvider` (used for chat attachments) with the authority `${applicationId}.im.crisp.client.uploadfileprovider`. This authority is merged automatically and does not conflict with your app's own `FileProvider`, so no additional configuration is required.
#### Push Notifications[ΒΆ](#push-notifications "Permanent link")
Push notifications on Android are delivered through [Firebase Cloud Messaging (FCM)](https://firebase.google.com/docs/cloud-messaging). There are two ways to integrate them:
**Option A β Crisp's own notification service (zero-config)**
If your app does not use its own `FirebaseMessagingService`, add the following service to the `application` tag of your `android/app/src/main/AndroidManifest.xml` file:
`[](#%5F%5Fcodelineno-4-1)
[](#%5F%5Fcodelineno-4-4)
[](#%5F%5Fcodelineno-4-5)
[](#%5F%5Fcodelineno-4-6)
[](#%5F%5Fcodelineno-4-7)
`
**Option B β Share an existing `FirebaseMessagingService`**
If your app already receives push notifications (e.g. via [@capacitor-firebase/messaging](https://github.com/capawesome-team/capacitor-firebase)), forward incoming messages to Crisp from your JavaScript code:
`[](#%5F%5Fcodelineno-5-1)import { FirebaseMessaging } from '@capacitor-firebase/messaging';
[](#%5F%5Fcodelineno-5-2)import { Crisp } from '@capawesome/capacitor-crisp';
[](#%5F%5Fcodelineno-5-3)
[](#%5F%5Fcodelineno-5-4)FirebaseMessaging.addListener('notificationReceived', async ({ notification }) => {
[](#%5F%5Fcodelineno-5-5) const data = notification.data ?? {};
[](#%5F%5Fcodelineno-5-6) const { crisp } = await Crisp.isCrispPushNotification({ data });
[](#%5F%5Fcodelineno-5-7) if (crisp) {
[](#%5F%5Fcodelineno-5-8) await Crisp.handlePushNotification({ data });
[](#%5F%5Fcodelineno-5-9) }
[](#%5F%5Fcodelineno-5-10)});
`
You can enable or disable Crisp push notifications at runtime with `setNotificationsEnabled(...)`.
### iOS[ΒΆ](#ios "Permanent link")
The Crisp iOS SDK can be integrated via Swift Package Manager (recommended) or CocoaPods.
> \[!NOTE\] Crisp will stop publishing new CocoaPods releases in September 2026\. We recommend using Swift Package Manager. If your app still uses CocoaPods, plan to migrate to Swift Package Manager before then.
#### Info.plist[ΒΆ](#infoplist "Permanent link")
The Crisp chatbox lets users send image and file attachments. Add the following keys to your `ios/App/App/Info.plist` file so users can attach photos:
`[](#%5F%5Fcodelineno-6-1)NSCameraUsageDescription
[](#%5F%5Fcodelineno-6-2)The app needs access to your camera to send photos in the chat.
[](#%5F%5Fcodelineno-6-3)NSPhotoLibraryAddUsageDescription
[](#%5F%5Fcodelineno-6-4)The app needs access to your photo library to send photos in the chat.
`
#### 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`).
The plugin automatically forwards the APNs device token to Crisp once your app has registered for remote notifications, so no additional token handling is required.
Use `setShouldPromptForNotificationPermission(...)` to control whether the Crisp SDK prompts the user for the notification permission.
### Web[ΒΆ](#web "Permanent link")
The web implementation loads the Crisp chatbox from Crisp'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 Crisp domains (e.g. `client.crisp.chat`, `*.crisp.chat`, and `wss://*.relay.crisp.chat`).
## Configuration[ΒΆ](#configuration "Permanent link")
No configuration required for this plugin.
## Usage[ΒΆ](#usage "Permanent link")
The following examples show how to use the plugin.
### Configure the plugin[ΒΆ](#configure-the-plugin "Permanent link")
Call `configure(...)` once before all other methods:
`[](#%5F%5Fcodelineno-7-1)import { Crisp } from '@capawesome/capacitor-crisp';
[](#%5F%5Fcodelineno-7-2)
[](#%5F%5Fcodelineno-7-3)const configure = async () => {
[](#%5F%5Fcodelineno-7-4) await Crisp.configure({
[](#%5F%5Fcodelineno-7-5) websiteId: 'YOUR_WEBSITE_ID',
[](#%5F%5Fcodelineno-7-6) });
[](#%5F%5Fcodelineno-7-7)};
`
### Open the chat[ΒΆ](#open-the-chat "Permanent link")
Open the Crisp chatbox:
`[](#%5F%5Fcodelineno-8-1)import { Crisp } from '@capawesome/capacitor-crisp';
[](#%5F%5Fcodelineno-8-2)
[](#%5F%5Fcodelineno-8-3)const openChat = async () => {
[](#%5F%5Fcodelineno-8-4) await Crisp.openChat();
[](#%5F%5Fcodelineno-8-5)};
`
### Set the user[ΒΆ](#set-the-user "Permanent link")
Set the information of the current user, optionally with identity verification:
`[](#%5F%5Fcodelineno-9-1)import { Crisp } from '@capawesome/capacitor-crisp';
[](#%5F%5Fcodelineno-9-2)
[](#%5F%5Fcodelineno-9-3)const setUser = async () => {
[](#%5F%5Fcodelineno-9-4) await Crisp.setUser({
[](#%5F%5Fcodelineno-9-5) email: 'jane.doe@example.com',
[](#%5F%5Fcodelineno-9-6) emailSignature: 'YOUR_HMAC_SIGNATURE',
[](#%5F%5Fcodelineno-9-7) nickname: 'Jane Doe',
[](#%5F%5Fcodelineno-9-8) });
[](#%5F%5Fcodelineno-9-9)};
`
### Attach session data[ΒΆ](#attach-session-data "Permanent link")
Attach custom data, segments, and events to the current session:
`[](#%5F%5Fcodelineno-10-1)import { Crisp, SessionEventColor } from '@capawesome/capacitor-crisp';
[](#%5F%5Fcodelineno-10-2)
[](#%5F%5Fcodelineno-10-3)const attachSessionData = async () => {
[](#%5F%5Fcodelineno-10-4) await Crisp.setSessionString({ key: 'plan', value: 'pro' });
[](#%5F%5Fcodelineno-10-5) await Crisp.setSessionSegment({ segment: 'checkout' });
[](#%5F%5Fcodelineno-10-6) await Crisp.pushSessionEvent({ name: 'purchase', color: SessionEventColor.Green });
[](#%5F%5Fcodelineno-10-7)};
`
### Listen for events[ΒΆ](#listen-for-events "Permanent link")
Listen for chat, message, and session events:
`[](#%5F%5Fcodelineno-11-1)import { Crisp } from '@capawesome/capacitor-crisp';
[](#%5F%5Fcodelineno-11-2)
[](#%5F%5Fcodelineno-11-3)const addListeners = async () => {
[](#%5F%5Fcodelineno-11-4) await Crisp.addListener('sessionLoaded', ({ sessionId }) => {
[](#%5F%5Fcodelineno-11-5) console.log('Session loaded:', sessionId);
[](#%5F%5Fcodelineno-11-6) });
[](#%5F%5Fcodelineno-11-7) await Crisp.addListener('messageReceived', ({ content }) => {
[](#%5F%5Fcodelineno-11-8) console.log('Message received:', content);
[](#%5F%5Fcodelineno-11-9) });
[](#%5F%5Fcodelineno-11-10)};
`
## API[ΒΆ](#api "Permanent link")
* [configure(...)](#configure)
* [handlePushNotification(...)](#handlepushnotification)
* [isCrispPushNotification(...)](#iscrisppushnotification)
* [openChat()](#openchat)
* [openHelpdeskArticle(...)](#openhelpdeskarticle)
* [pushSessionEvent(...)](#pushsessionevent)
* [resetSession()](#resetsession)
* [searchHelpdesk()](#searchhelpdesk)
* [setCompany(...)](#setcompany)
* [setNotificationsEnabled(...)](#setnotificationsenabled)
* [setSessionBool(...)](#setsessionbool)
* [setSessionInt(...)](#setsessionint)
* [setSessionSegment(...)](#setsessionsegment)
* [setSessionString(...)](#setsessionstring)
* [setShouldPromptForNotificationPermission(...)](#setshouldpromptfornotificationpermission)
* [setTokenId(...)](#settokenid)
* [setUser(...)](#setuser)
* [addListener('chatClosed', ...)](#addlistenerchatclosed-)
* [addListener('chatOpened', ...)](#addlistenerchatopened-)
* [addListener('messageReceived', ...)](#addlistenermessagereceived-)
* [addListener('messageSent', ...)](#addlistenermessagesent-)
* [addListener('sessionLoaded', ...)](#addlistenersessionloaded-)
* [removeAllListeners()](#removealllisteners)
* [Interfaces](#interfaces)
* [Enums](#enums)
### configure(...)[ΒΆ](#configure "Permanent link")
`[](#%5F%5Fcodelineno-12-1)configure(options: ConfigureOptions) => Promise
`
Configure the plugin with your Crisp website ID.
This method must be called before any other method.
| Param | Type |
| ----------- | ------------------------------------- |
| **options** | [ConfigureOptions](#configureoptions) |
**Since:** 0.1.0
---
### handlePushNotification(...)[ΒΆ](#handlepushnotification "Permanent link")
`[](#%5F%5Fcodelineno-13-1)handlePushNotification(options: HandlePushNotificationOptions) => Promise
`
Handle an incoming push notification that belongs to Crisp.
Use `isCrispPushNotification(...)` to check whether the notification belongs to Crisp before calling this method.
Only available on Android.
| Param | Type |
| ----------- | --------------------------------------------------------------- |
| **options** | [HandlePushNotificationOptions](#handlepushnotificationoptions) |
**Since:** 0.1.0
---
### isCrispPushNotification(...)[ΒΆ](#iscrisppushnotification "Permanent link")
`[](#%5F%5Fcodelineno-14-1)isCrispPushNotification(options: IsCrispPushNotificationOptions) => Promise
`
Check whether an incoming push notification belongs to Crisp.
Only available on Android.
| Param | Type |
| ----------- | ----------------------------------------------------------------- |
| **options** | [IsCrispPushNotificationOptions](#iscrisppushnotificationoptions) |
**Returns:** `Promise<[IsCrispPushNotificationResult](#iscrisppushnotificationresult)>`
**Since:** 0.1.0
---
### openChat()[ΒΆ](#openchat "Permanent link")
`[](#%5F%5Fcodelineno-15-1)openChat() => Promise
`
Open the chat.
**Since:** 0.1.0
---
### openHelpdeskArticle(...)[ΒΆ](#openhelpdeskarticle "Permanent link")
`[](#%5F%5Fcodelineno-16-1)openHelpdeskArticle(options: OpenHelpdeskArticleOptions) => Promise
`
Open a specific helpdesk article.
| Param | Type |
| ----------- | --------------------------------------------------------- |
| **options** | [OpenHelpdeskArticleOptions](#openhelpdeskarticleoptions) |
**Since:** 0.1.0
---
### pushSessionEvent(...)[ΒΆ](#pushsessionevent "Permanent link")
`[](#%5F%5Fcodelineno-17-1)pushSessionEvent(options: PushSessionEventOptions) => Promise
`
Push a session event to the current session.
| Param | Type |
| ----------- | --------------------------------------------------- |
| **options** | [PushSessionEventOptions](#pushsessioneventoptions) |
**Since:** 0.1.0
---
### resetSession()[ΒΆ](#resetsession "Permanent link")
`[](#%5F%5Fcodelineno-18-1)resetSession() => Promise
`
Reset the current session.
This clears the current session and starts a new one on the next interaction.
**Since:** 0.1.0
---
### searchHelpdesk()[ΒΆ](#searchhelpdesk "Permanent link")
`[](#%5F%5Fcodelineno-19-1)searchHelpdesk() => Promise
`
Open the helpdesk with the search view.
**Since:** 0.1.0
---
### setCompany(...)[ΒΆ](#setcompany "Permanent link")
`[](#%5F%5Fcodelineno-20-1)setCompany(options: SetCompanyOptions) => Promise
`
Set the company of the current user.
| Param | Type |
| ----------- | --------------------------------------- |
| **options** | [SetCompanyOptions](#setcompanyoptions) |
**Since:** 0.1.0
---
### setNotificationsEnabled(...)[ΒΆ](#setnotificationsenabled "Permanent link")
`[](#%5F%5Fcodelineno-21-1)setNotificationsEnabled(options: SetNotificationsEnabledOptions) => Promise
`
Enable or disable push notifications.
Only available on Android.
| Param | Type |
| ----------- | ----------------------------------------------------------------- |
| **options** | [SetNotificationsEnabledOptions](#setnotificationsenabledoptions) |
**Since:** 0.1.0
---
### setSessionBool(...)[ΒΆ](#setsessionbool "Permanent link")
`[](#%5F%5Fcodelineno-22-1)setSessionBool(options: SetSessionBoolOptions) => Promise
`
Set a boolean value for the given key in the current session.
| Param | Type |
| ----------- | ----------------------------------------------- |
| **options** | [SetSessionBoolOptions](#setsessionbooloptions) |
**Since:** 0.1.0
---
### setSessionInt(...)[ΒΆ](#setsessionint "Permanent link")
`[](#%5F%5Fcodelineno-23-1)setSessionInt(options: SetSessionIntOptions) => Promise
`
Set an integer value for the given key in the current session.
| Param | Type |
| ----------- | --------------------------------------------- |
| **options** | [SetSessionIntOptions](#setsessionintoptions) |
**Since:** 0.1.0
---
### setSessionSegment(...)[ΒΆ](#setsessionsegment "Permanent link")
`[](#%5F%5Fcodelineno-24-1)setSessionSegment(options: SetSessionSegmentOptions) => Promise
`
Set the segment of the current session.
| Param | Type |
| ----------- | ----------------------------------------------------- |
| **options** | [SetSessionSegmentOptions](#setsessionsegmentoptions) |
**Since:** 0.1.0
---
### setSessionString(...)[ΒΆ](#setsessionstring "Permanent link")
`[](#%5F%5Fcodelineno-25-1)setSessionString(options: SetSessionStringOptions) => Promise
`
Set a string value for the given key in the current session.
| Param | Type |
| ----------- | --------------------------------------------------- |
| **options** | [SetSessionStringOptions](#setsessionstringoptions) |
**Since:** 0.1.0
---
### setShouldPromptForNotificationPermission(...)[ΒΆ](#setshouldpromptfornotificationpermission "Permanent link")
`[](#%5F%5Fcodelineno-26-1)setShouldPromptForNotificationPermission(options: SetShouldPromptForNotificationPermissionOptions) => Promise
`
Set whether the user should be prompted for the notification permission.
Only available on iOS.
| Param | Type |
| ----------- | --------------------------------------------------------------------------------------------------- |
| **options** | [SetShouldPromptForNotificationPermissionOptions](#setshouldpromptfornotificationpermissionoptions) |
**Since:** 0.1.0
---
### setTokenId(...)[ΒΆ](#settokenid "Permanent link")
`[](#%5F%5Fcodelineno-27-1)setTokenId(options: SetTokenIdOptions) => Promise
`
Set the token ID of the current user.
The token ID is used to restore a session across devices and logins. You may also set it directly via `configure(...)`.
| Param | Type |
| ----------- | --------------------------------------- |
| **options** | [SetTokenIdOptions](#settokenidoptions) |
**Since:** 0.1.0
---
### setUser(...)[ΒΆ](#setuser "Permanent link")
`[](#%5F%5Fcodelineno-28-1)setUser(options: SetUserOptions) => Promise
`
Set the information of the current user.
| Param | Type |
| ----------- | --------------------------------- |
| **options** | [SetUserOptions](#setuseroptions) |
**Since:** 0.1.0
---
### addListener('chatClosed', ...)[ΒΆ](#addlistenerchatclosed "Permanent link")
`[](#%5F%5Fcodelineno-29-1)addListener(eventName: 'chatClosed', listenerFunc: () => void) => Promise
`
Called when the chat is closed.
| Param | Type |
| ---------------- | ------------ |
| **eventName** | 'chatClosed' |
| **listenerFunc** | () => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.1.0
---
### addListener('chatOpened', ...)[ΒΆ](#addlistenerchatopened "Permanent link")
`[](#%5F%5Fcodelineno-30-1)addListener(eventName: 'chatOpened', listenerFunc: () => void) => Promise
`
Called when the chat is opened.
| Param | Type |
| ---------------- | ------------ |
| **eventName** | 'chatOpened' |
| **listenerFunc** | () => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.1.0
---
### addListener('messageReceived', ...)[ΒΆ](#addlistenermessagereceived "Permanent link")
`[](#%5F%5Fcodelineno-31-1)addListener(eventName: 'messageReceived', listenerFunc: (event: MessageReceivedEvent) => void) => Promise
`
Called when a message is received from the operator.
| Param | Type |
| ---------------- | -------------------------------------------------------------- |
| **eventName** | 'messageReceived' |
| **listenerFunc** | (event: [MessageReceivedEvent](#messagereceivedevent)) => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.1.0
---
### addListener('messageSent', ...)[ΒΆ](#addlistenermessagesent "Permanent link")
`[](#%5F%5Fcodelineno-32-1)addListener(eventName: 'messageSent', listenerFunc: (event: MessageSentEvent) => void) => Promise
`
Called when a message is sent by the user.
| Param | Type |
| ---------------- | ------------------------------------------------------ |
| **eventName** | 'messageSent' |
| **listenerFunc** | (event: [MessageSentEvent](#messagesentevent)) => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.1.0
---
### addListener('sessionLoaded', ...)[ΒΆ](#addlistenersessionloaded "Permanent link")
`[](#%5F%5Fcodelineno-33-1)addListener(eventName: 'sessionLoaded', listenerFunc: (event: SessionLoadedEvent) => void) => Promise
`
Called when the session is loaded.
This is also the recommended way to get the session ID.
| Param | Type |
| ---------------- | ---------------------------------------------------------- |
| **eventName** | 'sessionLoaded' |
| **listenerFunc** | (event: [SessionLoadedEvent](#sessionloadedevent)) => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 0.1.0
---
### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link")
`[](#%5F%5Fcodelineno-34-1)removeAllListeners() => Promise
`
Remove all listeners for this plugin.
**Since:** 0.1.0
---
### Interfaces[ΒΆ](#interfaces "Permanent link")
#### ConfigureOptions[ΒΆ](#configureoptions "Permanent link")
| Prop | Type | Description | Since |
| ------------- | ------ | ------------------------------------- | ----- |
| **tokenId** | string | The token ID of the current user. | 0.1.0 |
| **websiteId** | string | The website ID of your Crisp website. | 0.1.0 |
#### HandlePushNotificationOptions[ΒΆ](#handlepushnotificationoptions "Permanent link")
| Prop | Type | Description | Since |
| -------- | ----------------------- | ---------------------------------- | ----- |
| **data** | Record | The data of the push notification. | 0.1.0 |
#### IsCrispPushNotificationResult[ΒΆ](#iscrisppushnotificationresult "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------- | ----------------------------------------------- | ----- |
| **crisp** | boolean | Whether the push notification belongs to Crisp. | 0.1.0 |
#### IsCrispPushNotificationOptions[ΒΆ](#iscrisppushnotificationoptions "Permanent link")
| Prop | Type | Description | Since |
| -------- | ----------------------- | ---------------------------------- | ----- |
| **data** | Record | The data of the push notification. | 0.1.0 |
#### OpenHelpdeskArticleOptions[ΒΆ](#openhelpdeskarticleoptions "Permanent link")
| Prop | Type | Description | Since |
| ------------ | ------ | ----------------------------- | ----- |
| **category** | string | The category of the article. | 0.1.0 |
| **id** | string | The ID (slug) of the article. | 0.1.0 |
| **locale** | string | The locale of the article. | 0.1.0 |
| **title** | string | The title of the article. | 0.1.0 |
#### PushSessionEventOptions[ΒΆ](#pushsessioneventoptions "Permanent link")
| Prop | Type | Description | Default | Since |
| --------- | --------------------------------------- | ----------------------- | ---------------------- | ----- |
| **color** | [SessionEventColor](#sessioneventcolor) | The color of the event. | SessionEventColor.Blue | 0.1.0 |
| **name** | string | The name of the event. | | 0.1.0 |
#### SetCompanyOptions[ΒΆ](#setcompanyoptions "Permanent link")
| Prop | Type | Description | Since |
| --------------- | ----------------------------------------------- | ------------------------------------------------------ | ----- |
| **description** | string | The description of the company. | 0.1.0 |
| **employment** | [SetCompanyEmployment](#setcompanyemployment) | The employment information of the user at the company. | 0.1.0 |
| **geolocation** | [SetCompanyGeolocation](#setcompanygeolocation) | The geolocation of the company. | 0.1.0 |
| **name** | string | The name of the company. | 0.1.0 |
| **url** | string | The URL of the company. | 0.1.0 |
#### SetCompanyEmployment[ΒΆ](#setcompanyemployment "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------ | ----------------------------------------- | ----- |
| **role** | string | The role of the user at the company. | 0.1.0 |
| **title** | string | The job title of the user at the company. | 0.1.0 |
#### SetCompanyGeolocation[ΒΆ](#setcompanygeolocation "Permanent link")
| Prop | Type | Description | Since |
| ----------- | ------ | --------------------------- | ----- |
| **city** | string | The city of the company. | 0.1.0 |
| **country** | string | The country of the company. | 0.1.0 |
#### SetNotificationsEnabledOptions[ΒΆ](#setnotificationsenabledoptions "Permanent link")
| Prop | Type | Description | Since |
| ----------- | ------- | --------------------------------------------- | ----- |
| **enabled** | boolean | Whether push notifications should be enabled. | 0.1.0 |
#### SetSessionBoolOptions[ΒΆ](#setsessionbooloptions "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------- | ------------------------------ | ----- |
| **key** | string | The key of the session data. | 0.1.0 |
| **value** | boolean | The value of the session data. | 0.1.0 |
#### SetSessionIntOptions[ΒΆ](#setsessionintoptions "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------ | ------------------------------ | ----- |
| **key** | string | The key of the session data. | 0.1.0 |
| **value** | number | The value of the session data. | 0.1.0 |
#### SetSessionSegmentOptions[ΒΆ](#setsessionsegmentoptions "Permanent link")
| Prop | Type | Description | Since |
| ----------- | ------ | --------------------------- | ----- |
| **segment** | string | The segment of the session. | 0.1.0 |
#### SetSessionStringOptions[ΒΆ](#setsessionstringoptions "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------ | ------------------------------ | ----- |
| **key** | string | The key of the session data. | 0.1.0 |
| **value** | string | The value of the session data. | 0.1.0 |
#### SetShouldPromptForNotificationPermissionOptions[ΒΆ](#setshouldpromptfornotificationpermissionoptions "Permanent link")
| Prop | Type | Description | Since |
| ----------- | ------- | -------------------------------------------------------------------- | ----- |
| **enabled** | boolean | Whether the user should be prompted for the notification permission. | 0.1.0 |
#### SetTokenIdOptions[ΒΆ](#settokenidoptions "Permanent link")
| Prop | Type | Description | Since |
| ----------- | ------ | --------------------------------- | ----- |
| **tokenId** | string | The token ID of the current user. | 0.1.0 |
#### SetUserOptions[ΒΆ](#setuseroptions "Permanent link")
| Prop | Type | Description | Since |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **avatarUrl** | string | The URL of the user's avatar. | 0.1.0 |
| **email** | string | The email address of the user. | 0.1.0 |
| **emailSignature** | string | The HMAC-SHA256 signature of the user's email address for identity verification. The signature must be generated on your backend using your Crisp secret key. Never expose the secret key in your app. | 0.1.0 |
| **nickname** | string | The nickname of the user. | 0.1.0 |
| **phone** | string | The phone number of the user. | 0.1.0 |
#### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link")
| Prop | Type |
| ---------- | ------------------- |
| **remove** | () => Promise |
#### MessageReceivedEvent[ΒΆ](#messagereceivedevent "Permanent link")
| Prop | Type | Description | Since |
| ----------- | -------------- | ---------------------------------------------------------------------------------------------------------------- | ----- |
| **content** | string \| null | The text content of the message. This is null if the message has no text content (e.g. a file or audio message). | 0.1.0 |
#### MessageSentEvent[ΒΆ](#messagesentevent "Permanent link")
| Prop | Type | Description | Since |
| ----------- | -------------- | ---------------------------------------------------------------------------------------------------------------- | ----- |
| **content** | string \| null | The text content of the message. This is null if the message has no text content (e.g. a file or audio message). | 0.1.0 |
#### SessionLoadedEvent[ΒΆ](#sessionloadedevent "Permanent link")
| Prop | Type | Description | Since |
| ------------- | ------ | ----------------------------- | ----- |
| **sessionId** | string | The ID of the loaded session. | 0.1.0 |
### Enums[ΒΆ](#enums "Permanent link")
#### SessionEventColor[ΒΆ](#sessioneventcolor "Permanent link")
| Members | Value | Since |
| ---------- | -------- | ----- |
| **Black** | 'BLACK' | 0.1.0 |
| **Blue** | 'BLUE' | 0.1.0 |
| **Brown** | 'BROWN' | 0.1.0 |
| **Green** | 'GREEN' | 0.1.0 |
| **Grey** | 'GREY' | 0.1.0 |
| **Orange** | 'ORANGE' | 0.1.0 |
| **Pink** | 'PINK' | 0.1.0 |
| **Purple** | 'PURPLE' | 0.1.0 |
| **Red** | 'RED' | 0.1.0 |
| **Yellow** | 'YELLOW' | 0.1.0 |
## Platform Support[ΒΆ](#platform-support "Permanent link")
Not every Crisp SDK feature is available on all platforms. The following table lists the per-platform differences of the plugin's API:
| Method | Android | iOS | Web |
| --------------------------------------------- | ------- | --- | --- |
| setSessionBool(...) | β
| β
| β
|
| isCrispPushNotification(...) | β
| β | β |
| handlePushNotification(...) | β
| β | β |
| setNotificationsEnabled(...) | β
| β | β |
| setShouldPromptForNotificationPermission(...) | β | β
| β |
On iOS, the Crisp SDK detects and handles its own push notifications internally once the APNs device token has been forwarded, so the JavaScript `isCrispPushNotification(...)` and `handlePushNotification(...)` methods are not available there.
The following features of the Crisp SDKs are intentionally not part of this plugin's initial release: unread message count, bot scenarios, runtime locale override, and audio/video calls. [Open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) if you need any of them.
## Licensing[ΒΆ](#licensing "Permanent link")
The Crisp Android and iOS SDKs are proprietary, closed-source binaries provided by Crisp IM SAS. This plugin only declares them as dependencies (via Maven, CocoaPods, and Swift Package Manager) and does not bundle or modify them. Using the plugin requires an active Crisp account and website ID. The MIT license of this plugin covers the wrapper code only, not the Crisp SDKs.
## FAQ[ΒΆ](#faq "Permanent link")
### Do I need a Crisp account to use this plugin?[ΒΆ](#do-i-need-a-crisp-account-to-use-this-plugin "Permanent link")
Yes. This plugin wraps the official Crisp SDKs, which require an active [Crisp](https://crisp.chat/) account and a website ID.
### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link")
This plugin exposes the Crisp SDKs through a fully typed API, including a strongly typed listener for each event and dedicated helpdesk methods. Identity verification is built in through email-signature HMAC, and push notifications are handled entirely through Crisp's public API. It ships a typed web implementation alongside Android and iOS, supports Swift Package Manager ahead of the CocoaPods sunset, and stays unopinionated by never forcing an automatic show or hide of the chatbox. It is actively maintained and backed by dedicated support.
### How do I get the session ID?[ΒΆ](#how-do-i-get-the-session-id "Permanent link")
Listen for the `sessionLoaded` event. The event payload contains the `sessionId`. There is no synchronous getter, because the session is loaded asynchronously.
### How does identity verification work?[ΒΆ](#how-does-identity-verification-work "Permanent link")
Generate an HMAC-SHA256 signature of the user's email address on your backend using your Crisp secret key, then pass it as the `emailSignature` option of `setUser(...)`. 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/crisp/CHANGELOG.md).
## License[ΒΆ](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/crisp/LICENSE).
---
1. This project is not affiliated with, endorsed by, sponsored by, or approved by Crisp IM SAS or any of its affiliates or subsidiaries. "Crisp" is a trademark of Crisp IM SAS. [β©](#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/crisp/#article", "headline": "Capacitor Crisp Plugin for Android, iOS & Web", "name": "Capacitor Crisp Plugin for Android, iOS & Web", "description": "Unofficial Capacitor plugin for Crisp to add the Crisp chat SDK to your app on Android, iOS, and Web with chatbox, helpdesk, and push notifications.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/crisp/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/crisp/", "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/crisp/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/crisp/#software", "name": "Capacitor Crisp Plugin for Android, iOS & Web", "description": "Unofficial Capacitor plugin for Crisp to add the Crisp chat SDK to your app on Android, iOS, and Web with chatbox, helpdesk, and push notifications.", "url": "https://capawesome.io/docs/sdks/capacitor/crisp/", "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 a Crisp account to use this plugin?", "acceptedAnswer": {"@type": "Answer", "text": "Yes. This plugin wraps the official Crisp SDKs, which require an active Crisp account and a website ID."}}, {"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "This plugin exposes the Crisp SDKs through a fully typed API, including a strongly typed listener for each event and dedicated helpdesk methods. Identity verification is built in through email-signature HMAC, and push notifications are handled entirely through Crisp's public API. It ships a typed web implementation alongside Android and iOS, supports Swift Package Manager ahead of the CocoaPods sunset, and stays unopinionated by never forcing an automatic show or hide of the chatbox. It is actively maintained and backed by dedicated support."}}, {"@type": "Question", "name": "How do I get the session ID?", "acceptedAnswer": {"@type": "Answer", "text": "Listen for the sessionLoaded event. The event payload contains the sessionId. There is no synchronous getter, because the session is loaded asynchronously."}}, {"@type": "Question", "name": "How does identity verification work?", "acceptedAnswer": {"@type": "Answer", "text": "Generate an HMAC-SHA256 signature of the user's email address on your backend using your Crisp secret key, then pass it as the emailSignature option of setUser(...). 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/crisp/"}
```