Flutter SDK
Embed the Kerabie help desk in a Flutter app.
Install
flutter pub add kerabie_helpdesk_flutter
Package
kerabie_helpdesk_flutter
Language
Dart
Platforms
iOS and Android
What it is
The Kerabie Flutter SDK (kerabie_helpdesk_flutter on pub.dev) adds live chat to any Flutter app: a provider, a launcher, a full chat screen and ready-made help centre, ticket and store screens that talk to the same Kerabie inbox as your website widget and your React Native app.
Included on every plan, including Free.
Provider, launcher and chat screen
Wrap your app once, add the launcher, and customers can message you from any screen. The dashboard decides between a floating button and a search bar.
Same inbox as web and React Native
Conversations from Flutter arrive in the same Kerabie inbox as your website widget and your React Native app.
Photos, files and emoji
Customers attach photos and documents, pick emoji, see link previews and open the help articles an AI reply used.
Help centre, tickets and store
Ready-made screens for the knowledge base with article feedback, support tickets and your store.
Campaigns
Proactive messages from the dashboard appear in the app, limited to screens, audiences and frequencies, and their results are counted.
Context and identity
Open the chat with an order, a product or a payment so agents see what the customer was looking at, and update who the customer is as they sign in and out.
Themeable
Colours, widget name, welcome message, launcher icon and branding follow your dashboard settings, in light and dark mode, and you can override any of them in code.
Real-time
Messages, typing and AI replies that stream in word by word arrive over a socket connection, with an unread count you can show in your own UI.
Notifications and links
Register one push token and open the chat from a tapped notification or a myapp://conversation/123 link.
Code
import 'package:flutter/material.dart';
import 'package:kerabie_helpdesk_flutter/kerabie_helpdesk_flutter.dart';
final navigatorKey = GlobalKey<NavigatorState>();
void main() {
runApp(
KerabieProvider(
navigatorKey: navigatorKey,
config: const KerabieConfig(
widgetKey: 'wk_yourorg_123',
appName: 'My App',
appVersion: '1.0.0',
user: KerabieUser(name: 'Jane', email: 'jane@example.com'),
),
child: MaterialApp(
navigatorKey: navigatorKey,
home: const Scaffold(
body: Stack(children: [HomeScreen(), KerabieLauncher()]),
),
),
),
);
}final kerabie = KerabieProvider.of(context, listen: false);
final messaging = FirebaseMessaging.instance;
await kerabie.registerPushToken(
(await messaging.getToken())!,
provider: KerabiePushProvider.fcm,
);
final initial = await messaging.getInitialMessage();
if (initial != null) kerabie.handleNotificationData(initial.data);
FirebaseMessaging.onMessageOpenedApp
.listen((m) => kerabie.handleNotificationData(m.data));Requirements
- Flutter 3.27 or later, Dart 3.6 or later
- A widget key from Settings, Widget
- Android or iOS
Questions
Does Kerabie have a Flutter SDK?
Yes. It is the kerabie_helpdesk_flutter package on pub.dev, installed with flutter pub add kerabie_helpdesk_flutter.
Is the Flutter SDK free?
Yes. Like the React Native SDK it is included on every Kerabie plan, including Free.
Does it work on web and desktop?
The SDK targets iOS and Android. For websites, use the Kerabie web widget.
More from Kerabie for developers
Ship with Kerabie today
Create a free workspace, grab your key and install in minutes.