capacitor-plugin-zendesk-chat

This capacitor plugin implement Zendesk messaging into IOS, Android and web platforms.

Zendesk documentation here https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/

This page gives you the basic steps for getting up and running with the Support SDK.

Install

npm install capacitor-plugin-zendesk-support
npx cap sync

Usage

API keys are in Zendesk Admin center on Messaging page

import { ZendeskSupport } from "capacitor-plugin-zendesk-support";

await ZendeskSupport.initialize({
      iosChatId: 'ios chat id',
      androidChatId: 'android chat id',
      webClientId: 'web widget key',
      debugLog: false
});

await ZendeskSupport.openChat();

API

• initialize(...)
• setAnonymousIdentity(...)
• setIdentity(...)
• openChat()
• closeChat()
• Interfaces

initialize(...)

initialize(options: InitializeOptions) => Promise<void>

Param	Type
options	InitializeOptions

---

setAnonymousIdentity(...)

setAnonymousIdentity(options: AnonymousOptions) => Promise<void>

Param	Type
options	AnonymousOptions

---

setIdentity(...)

setIdentity(option: IdentityOption) => Promise<void>

Param	Type
option	IdentityOption

---

openChat()

openChat() => Promise<void>

---

closeChat()

closeChat() => Promise<void>

---

Interfaces

InitializeOptions

Prop	Type
iosChatId	string
androidChatId	string
webClientId	string
debugLog	boolean

AnonymousOptions

Prop	Type
name	string
email	string

IdentityOption

Prop	Type
token	string