Integrate the Helpscout Beacon into your React Native app.
This library is compatible with and supported for React Native v0.60+.
- Download package
# npm
npm install react-native-helpscout-beacon
# yarn
yarn add react-native-helpscout-beacon
- Install pods (skip for expo projects)
cd ios && pod install
Can be updated in your main project directory by running
cd ios/ && pod update BeaconPlease create an issue in this repo in case it doesn't work as expected.
Has to be updated in this module's android/build.gradle, i.e. the version in the following line has to be adapted
implementation "com.helpscout:beacon:4.1.0"import HelpscoutBeacon from 'react-native-helpscout-beacon';
// init has to be called first
HelpscoutBeacon.init('my_helpscout_id');
// Login into your helpscout account
HelpscoutBeacon.login(
'email@address.com',
'John Smith',
'user_id_of_john_smith'
);
// Open the helpscout beacon (using a cryptographic signature)
HelpscoutBeacon.open('mySignature');Generally, please refer to the official docs for ios and android for documentation on the following methods.
Not all methods of the SDKs are implemented so far.
Initialize the Helpscout beacon library - has to be called before any other Helpscout method.
HelpscoutBeacon.init('my_helpscout_id');Identify a helpscout user with email (and optional name)
HelpscoutBeacon.identify('email@address.com', 'John Smith');Logout user from the Helpscout Beacon.
HelpscoutBeacon.logout();Used to add an user attribute represented as a key / value pair. There is a limit of 30 attributes per user.
HelpscoutBeacon.addAttributeWithKey('some_key', 'some_value');Opens the Helpscout Beacon with Help Center articles.
The init and login methods will need to have been called before this will work.
May be used without arguments or with an optional signature (secure mode).
HelpscoutBeacon.open('my_signature');Opens the Helpscout Beacon at a specific Help Center article. (Helpscout docs integration has to be enabled)
HelpscoutBeacon.openArticle('some_article_id', 'my_signature');The suggestArticles method allows you to change the default list of suggested articles. Article IDs can be found in Help Scout by navigating to the article and copying the article ID from the URL. The URL is structured like this: https://secure.helpscout.net/docs/[COLLECTION ID]/article/[ARTICLE ID]/.
Custom suggestions will only get loaded when the Beacon is opened. If the Beacon is not present, loading the custom suggestion data will get queued up for the next Beacon display.
Notes:
- There is a limit of 5 article IDs. If the list is larger than 5 the additional articles will be ignored.
- The Helpscout docs integration has to be enabled for this method to work.
const articleIDList = ['id1', 'id2', 'id3'];
HelpscoutBeacon.suggestArticles(articleIDList);Reset any suggested articles set by suggestArticles back to Helpscouts own default suggestions.
HelpscoutBeacon.resetSuggestions();Display a specific page in the Helpscout beacon. On Android, these paths are supported:
- "/ask/message/"
- "/ask/chat/"
- "/answers/"
iOS supports additional paths e.g. "/" which displays the initial state of the beacon. Find supported path values here.
HelpscoutBeacon.navigate('/ask/message');These methods are not part of the original SDKs but have proven to be useful.
Convenience method to identify the user via setting an attribute with key userId.
HelpscoutBeacon.login(
'email@address.com',
'John Smith',
'user_id_of_john_smith'
);It is equivalent to
HelpscoutBeacon.identify('email@address.com', 'John Smith');
HelpscoutBeacon.addAttributeWithKey('userId', 'user_id_of_john_smith');Convenience method to login via setting an attribute with key userId and opening the Helpscout beacon (with optional signature).
HelpscoutBeacon.loginAndOpen(
'email@address.com',
'John Smith',
'user_id_of_john_smith',
'mySignature'
);