Skip to main content

Integrate Chatwoot with React Native app

If you have a react native app, you can add Chatwoot live chat widget to it and talk to your visitors in real time.

Chatwoot lets you chat with your visitors and provide exceptional support in real time. To use Chatwoot in your react native app, follow the steps described below.

1. Create a Website Channel in Chatwoot

As a first step, you will need a website channel configured in your Chatwoot account. To learn how to do this step-by-step, refer to the Website Channel document.

2. Add the plugin to your project

Add one of the following plugins to your project:

yarn add @chatwoot/react-native-widget

or

npm install --save @chatwoot/react-native-widget --save

This library depends on react-native-webview and async-storage. Please follow the instructions provided in the docs.

iOS Installation

If you're using React Native versions > 60.0, it's relatively straightforward.

cd ios && pod install

3. Use it like this

Replace websiteToken and baseUrl with appropriate values.

import React, { useState } from 'react';
import { StyleSheet, View, SafeAreaView, TouchableOpacity, Text } from 'react-native';
import ChatWootWidget from '@chatwoot/react-native-widget';

const App = () => {
const [showWidget, toggleWidget] = useState(false);
const user = {
identifier: 'john@gmail.com',
name: 'John Samuel',
avatar_url: '',
email: 'john@gmail.com',
identifier_hash: '',
};
const customAttributes = { accountId: 1, pricingPlan: 'paid', status: 'active' };
const websiteToken = 'WEBSITE_TOKEN';
const baseUrl = 'CHATWOOT_INSTALLATION_URL';
const locale = 'en';

return (
<SafeAreaView style={styles.container}>
<View>
<TouchableOpacity style={styles.button} onPress={() => toggleWidget(true)}>
<Text style={styles.buttonText}>Open widget</Text>
</TouchableOpacity>
</View>
{
showWidget&&
<ChatWootWidget
websiteToken={websiteToken}
locale={locale}
baseUrl={baseUrl}
closeModal={() => toggleWidget(false)}
isModalVisible={showWidget}
user={user}
customAttributes={customAttributes}
/>
}

</SafeAreaView>
);
};

const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
},

button: {
height: 48,
marginTop: 32,
paddingTop: 8,
paddingBottom: 8,
backgroundColor: '#1F93FF',
borderRadius: 8,
borderWidth: 1,
borderColor: '#fff',
justifyContent: 'center',
},
buttonText: {
color: '#fff',
textAlign: 'center',
paddingLeft: 10,
fontWeight: '600',
fontSize: 16,
paddingRight: 10,
},
});

export default App;

Hooray! You're done.

Check out the full example here.

Props

NameDefaultTypeDescription
baseUrl-StringChatwoot Installation URL
websiteToken-StringWebsite Channel Token
localeenStringLocale to be used in the widget. Chatwoot support 25+ language. See Langauge Config to see the supported ISO 639-1 codes
isModalVisiblefalseBooleanFlag used to set the display of the widget modal
closeModal-FunctionHandler method for the callback when the modal is closed
userObjectPass the information about the user like email, name and avatar_url
customAttributesObjectIf you want to set additional information about user, pass the key value pair here