Streamline customer communications in your app with the Help Scout Beacon SDK for Flutter.
See Demo
Add your BeaconId in main.dart
Configure the beacon with your Beacon ID and launch the beacon UI by calling open.
final HelpScoutBeacon beacon = HelpScoutBeacon(HSBeaconSettings(beaconId: 'YOUR_BEACON_ID'));
beacon.open();Optionally you can prefill the beacon with user meta data:
final settings = HSBeaconSettings(beaconId: 'YOUR_BEACON_ID', debugLogging: true);
final HelpScoutBeacon beacon = HelpScoutBeacon(settings);
final user = HSBeaconUser(email: "john.doe@example.com", name: "John Doe");
beacon.identify(beaconUser: user);
beacon.open();Open a desired page in the Help Scout beacon UI:
beacon.open(route: HSBeaconRoute.ask);
beacon.open(route: HSBeaconRoute.chat);
beacon.open(route: HSBeaconRoute.contactForm);
beacon.open(route: HSBeaconRoute.previousMessages);
beacon.open(route: HSBeaconRoute.docs);
beacon.open(route: HSBeaconRoute.docs, parameter: 'search term');
beacon.open(route: HSBeaconRoute.article, paramter: 'article id');Once done you can remove all data:
beacon.clear()The newest version on Android requires to setup pro-guard rules. See example project proguard-rules.pro