Simple module that allows displaying Zopim Chat from Zendesk for React Native.


  • For RN version higher than 0.59 use version >= 0.3.0 (Zendesk Chat v1)
  • For RN version lower than 0.59 use version <= 0.2.2 (Zendesk Chat v1)

Known Issues

Getting Started

Follow the instructions to install the SDK for iOS and Android.

With npm:

npm install react-native-zendesk-chat --save

or with yarn:

yarn add react-native-zendesk-chat

QuickStart & Usage

  1. Setup Native Dependencies
    iOS If you're on react-native >= 0.60 and you have Cocoapods setup, then you just need to:
$ yarn install # and see if there are any errors
$ (cd ios; pod install) # and see if there are any errors
 # -- you may need to do `pod install --repo-update`

If you're on older react-native versions, please see the Advanced Setup section below

Android If you're on react-native >= 0.60, Android should autodetect this dependency. You may need to call react-native link

  1. Call the JS Initializer:
import ZendeskChat from "react-native-zendesk-chat";

// Once in your application:
  1. Show the Chat UI
// On button press, when you want to show chat:
	name: user.full_name,
	phone: user.mobile_phone,
	tags: ["tag1", "tag2"],
	department: "Your department",

Advanced Setup

Advanced users, or users running on older versions of react-native may want to initialize things in native.

iOS: Manually Setting up with Cocoapods

If you're on iOS < 0.60, you may need to manually install the cocoapod:

Add a reference to your Podfile:

pod 'RNZendeskChat', :git => ''

then run pod install: (cd ios; pod install)

or manually:

In Xcode, drag and drop node_modules/react-native-zendesk-chat/RNZendeskChat.m and node_modules/react-native-zendesk-chat/RNZendeskChat.h into your project.

iOS: Configure ZDCChat in AppDelegate.m:

#import <ZDCChat/ZDCChat.h>

// ...

// Inside the appropriate appDidFinishLaunching method
[ZDCChat initializeWithAccountKey:@"YOUR_ZENDESK_ACCOUNT_KEY"];

// And access other interesting APIs

Android: Manual Setup & Configuration

If you're on react-native < 0.60, you should be able to call react-native link.

If this doesn't work, then you may need to do a complete manual install as follows:

  1. Open up android/app/main/java/[...]/
  • Add import com.taskrabbit.zendesk.*; to the imports at the top of the file
  • Add new RNZendeskChatPackage(this) to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
include ':react-native-zendesk-chat'
project(':react-native-zendesk-chat').projectDir = new File(rootProject.projectDir,	'../node_modules/react-native-zendesk-chat/android')
  1. Insert the following lines inside the dependencies block in android/app/build.gradle:
compile project(':react-native-zendesk-chat')
  1. Configure ZopimChat in android/app/main/java/[...]/
// Note: there is a JS method to do this!
// Call this once in your Activity's bootup lifecycle


  • Allow setting form configuration from JS
  • Add examples


React Native is MIT licensed, as found in the LICENSE file.

Last updated



npm install react-native-zendesk-chat
yarn add react-native-zendesk-chat




  • taskrabbit