{"id":15062645,"url":"https://github.com/cap-go/capacitor-crisp","last_synced_at":"2026-04-27T09:02:34.008Z","repository":{"id":49323083,"uuid":"429967671","full_name":"Cap-go/capacitor-crisp","owner":"Cap-go","description":"Crisp native SDK for capacitor","archived":false,"fork":false,"pushed_at":"2025-04-01T15:45:30.000Z","size":991,"stargazers_count":8,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T17:54:05.309Z","etag":null,"topics":["android","capacitor","capacitor-plugin","crisp","ionic","ios"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/capacitor-crisp","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-11-20T00:08:45.000Z","updated_at":"2025-03-03T04:54:55.000Z","dependencies_parsed_at":"2023-07-16T07:52:24.807Z","dependency_job_id":"ade722b0-a60b-4d03-a79a-a56a02d68708","html_url":"https://github.com/Cap-go/capacitor-crisp","commit_stats":{"total_commits":229,"total_committers":3,"mean_commits":76.33333333333333,"dds":0.554585152838428,"last_synced_commit":"1d4f9e86eefbec73cce75118a20da87abc534e2b"},"previous_names":["riderx/capacitor-crisp"],"tags_count":113,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-crisp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-crisp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-crisp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-crisp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-crisp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198884,"owners_count":21063628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","capacitor","capacitor-plugin","crisp","ionic","ios"],"created_at":"2024-09-24T23:44:04.020Z","updated_at":"2026-04-27T09:02:33.991Z","avatar_url":"https://github.com/Cap-go.png","language":"Swift","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# capacitor-crisp\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_crisp\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_crisp\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\nCrisp native SDK for capacitor\n\n## Why Capacitor Crisp?\n\nThe only free Capacitor plugin for integrating Crisp.chat's native SDK into your mobile apps. Crisp is a powerful customer support and messaging platform, and this plugin provides:\n\n- **Native SDK integration** - Full access to Crisp's native mobile SDKs for iOS and Android\n- **Rich messaging features** - Live chat, user profiles, custom data, events, and segmentation\n- **Two-way communication** - Send messages programmatically and track user behavior\n- **Complete API** - Full feature parity with Crisp's JavaScript API\n\nPerfect for apps needing customer support, helpdesk functionality, or user engagement tools.\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/crisp/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-crisp\nnpx cap sync\n```\n\n## Init\n\nCall configure in your code Before any other method :\n```\nimport { CapacitorCrisp } from '@capgo/capacitor-crisp';\n\nCapacitorCrisp.configure({websiteID: '******-****-****-****-********'})\n```\n### iOS\n\nTo enable your users to take and upload photos to the chat as well as download photos to their photo library, add :\n\nPrivacy - Camera Usage Description (NSCameraUsageDescription)\n\nPrivacy - Photo Library Additions Usage Description (NSPhotoLibraryAddUsageDescription) \n\nto your app's Info.plist.\n\n### Android Integration\nNothing special to do.\n\n\n## Open chatbox\n\n```\nimport { CapacitorCrisp } from '@capgo/capacitor-crisp';\n\nCapacitorCrisp.openMessenger()\n```\n## API\n\n\u003cdocgen-index\u003e\n\n* [`configure(...)`](#configure)\n* [`openMessenger()`](#openmessenger)\n* [`setTokenID(...)`](#settokenid)\n* [`setUser(...)`](#setuser)\n* [`pushEvent(...)`](#pushevent)\n* [`setCompany(...)`](#setcompany)\n* [`setInt(...)`](#setint)\n* [`setString(...)`](#setstring)\n* [`sendMessage(...)`](#sendmessage)\n* [`setSegment(...)`](#setsegment)\n* [`reset()`](#reset)\n* [`getPluginVersion()`](#getpluginversion)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\nCrisp Chat SDK Plugin for Capacitor.\nProvides live chat and customer support functionality through Crisp.chat.\n\n### configure(...)\n\n```typescript\nconfigure(data: ConfigureOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nConfigure the Crisp SDK with your website ID.\nMust be called before using any other methods.\n\n| Param      | Type                                                          | Description            |\n| ---------- | ------------------------------------------------------------- | ---------------------- |\n| **`data`** | \u003ccode\u003e\u003ca href=\"#configureoptions\"\u003eConfigureOptions\u003c/a\u003e\u003c/code\u003e | - Configuration object |\n\n--------------------\n\n\n### openMessenger()\n\n```typescript\nopenMessenger() =\u003e Promise\u003cvoid\u003e\n```\n\nOpen the Crisp messenger chat window.\nShows the chat interface to the user.\n\n--------------------\n\n\n### setTokenID(...)\n\n```typescript\nsetTokenID(data: { tokenID: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet a unique token ID for the current user session.\nUsed to identify and restore previous conversations.\n\n| Param      | Type                              | Description         |\n| ---------- | --------------------------------- | ------------------- |\n| **`data`** | \u003ccode\u003e{ tokenID: string; }\u003c/code\u003e | - Token data object |\n\n--------------------\n\n\n### setUser(...)\n\n```typescript\nsetUser(data: { nickname?: string; phone?: string; email?: string; avatar?: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet user information for the current session.\nUpdates the user profile visible to support agents.\n\n| Param      | Type                                                                                 | Description               |\n| ---------- | ------------------------------------------------------------------------------------ | ------------------------- |\n| **`data`** | \u003ccode\u003e{ nickname?: string; phone?: string; email?: string; avatar?: string; }\u003c/code\u003e | - User information object |\n\n--------------------\n\n\n### pushEvent(...)\n\n```typescript\npushEvent(data: { name: string; color: eventColor; }) =\u003e Promise\u003cvoid\u003e\n```\n\nPush a custom event to Crisp.\nUseful for tracking user actions and behavior.\n\n| Param      | Type                                                                        | Description         |\n| ---------- | --------------------------------------------------------------------------- | ------------------- |\n| **`data`** | \u003ccode\u003e{ name: string; color: \u003ca href=\"#eventcolor\"\u003eeventColor\u003c/a\u003e; }\u003c/code\u003e | - Event data object |\n\n--------------------\n\n\n### setCompany(...)\n\n```typescript\nsetCompany(data: { name: string; url?: string; description?: string; employment?: [title: string, role: string]; geolocation?: [country: string, city: string]; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet company information for the current session.\nAssociates the user with a company in Crisp.\n\n| Param      | Type                                                                                                                                                          | Description                  |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |\n| **`data`** | \u003ccode\u003e{ name: string; url?: string; description?: string; employment?: [title: string, role: string]; geolocation?: [country: string, city: string]; }\u003c/code\u003e | - Company information object |\n\n--------------------\n\n\n### setInt(...)\n\n```typescript\nsetInt(data: { key: string; value: number; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet a custom integer data field.\nStores numerical data associated with the user session.\n\n| Param      | Type                                         | Description           |\n| ---------- | -------------------------------------------- | --------------------- |\n| **`data`** | \u003ccode\u003e{ key: string; value: number; }\u003c/code\u003e | - Integer data object |\n\n--------------------\n\n\n### setString(...)\n\n```typescript\nsetString(data: { key: string; value: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet a custom string data field.\nStores text data associated with the user session.\n\n| Param      | Type                                         | Description          |\n| ---------- | -------------------------------------------- | -------------------- |\n| **`data`** | \u003ccode\u003e{ key: string; value: string; }\u003c/code\u003e | - String data object |\n\n--------------------\n\n\n### sendMessage(...)\n\n```typescript\nsendMessage(data: { value: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSend a message from the user to the chat.\nProgrammatically send a message as if the user typed it.\n\n| Param      | Type                            | Description           |\n| ---------- | ------------------------------- | --------------------- |\n| **`data`** | \u003ccode\u003e{ value: string; }\u003c/code\u003e | - Message data object |\n\n--------------------\n\n\n### setSegment(...)\n\n```typescript\nsetSegment(data: { segment: string; }) =\u003e Promise\u003cvoid\u003e\n```\n\nSet a user segment for targeting and organization.\nUsed to categorize users in the Crisp dashboard.\n\n| Param      | Type                              | Description           |\n| ---------- | --------------------------------- | --------------------- |\n| **`data`** | \u003ccode\u003e{ segment: string; }\u003c/code\u003e | - Segment data object |\n\n--------------------\n\n\n### reset()\n\n```typescript\nreset() =\u003e Promise\u003cvoid\u003e\n```\n\nReset the Crisp session.\nClears all user data and starts a fresh session.\nUseful when user logs out.\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the plugin version number.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### Interfaces\n\n\n#### ConfigureOptions\n\nConfiguration for initializing Crisp.\n\n| Prop            | Type                | Description                                                                                                                                                            |\n| --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`websiteID`** | \u003ccode\u003estring\u003c/code\u003e | Your Crisp website ID from dashboard.                                                                                                                                  |\n| **`locale`**    | \u003ccode\u003estring\u003c/code\u003e | Optional - Locale to force in the Crisp chat widget (ISO 639-1), eg. `en`, `fr`, `es`. Web + Android: overrides the runtime locale. iOS follows the device/app locale. |\n| **`tokenID`**   | \u003ccode\u003estring\u003c/code\u003e | Optional - Unique token identifier for the user session continuity.                                                                                                    |\n\n\n### Type Aliases\n\n\n#### eventColor\n\nAvailable colors for Crisp events.\nUsed to visually categorize events in the Crisp dashboard.\n\n\u003ccode\u003e'red' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown' | 'grey' | 'black'\u003c/code\u003e\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-crisp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-crisp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-crisp/lists"}