@capgo/capacitor-crisp
Crisp Chat SDK Plugin for Capacitor. Provides live chat and customer support functionality through Crisp.chat.
Overview
Section titled “Overview”Crisp Chat SDK Plugin for Capacitor. Provides live chat and customer support functionality through Crisp.chat.
Core Capabilities
Section titled “Core Capabilities”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.
Public API
Section titled “Public API”| Method | Description |
|---|---|
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. |
pushEvent | Push a custom event to Crisp. Useful for tracking user actions and behavior. |
setCompany | Set company information for the current session. Associates the user with a company in Crisp. |
setInt | Set a custom integer data field. Stores numerical data associated with the user session. |
setString | Set a custom string data field. Stores text data associated with the user session. |
sendMessage | Send a message from the user to the chat. Programmatically send a message as if the user typed it. |
setSegment | Set a user segment for targeting and organization. Used to categorize users in the Crisp dashboard. |
reset | Reset the Crisp session. Clears all user data and starts a fresh session. Useful when user logs out. |
getPluginVersion | Get the plugin version number. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-crisp.
Keep going from @capgo/capacitor-crisp
Section titled “Keep going from @capgo/capacitor-crisp”If you are using @capgo/capacitor-crisp to plan native plugin work, connect it with Using @capgo/capacitor-crisp for the native capability in Using @capgo/capacitor-crisp, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.