Courier Flutter SDK
The Courier Flutter SDK provides prebuilt widgets and Dart APIs for adding in-app notifications, push notifications, and notification preferences to your Flutter app. It handles authentication, token management, and real-time message delivery across iOS and Android from a single codebase.
Requires Flutter 3.29+ (Dart 3.7+), iOS 15.0+, Android SDK 23+, and Gradle 8.4+.
Installation
flutter pub add courier_flutter
iOS
Flutter sets up the native iOS SDK, Courier_iOS, when it builds.
Notification service extension: add Courier_iOS to the extension target with Swift Package Manager. In Xcode, choose File > Add Package Dependencies, enter https://github.com/trycourier/courier-ios, and pick Up to Next Major Version. If the extension has pod 'Courier_iOS' in your Podfile, remove it.
Quick Start
import 'package:courier_flutter/courier_flutter.dart';
import 'package:courier_flutter/ui/inbox/courier_inbox.dart';
// Sign in (JWT generated by your backend)
await Courier.shared.signIn(
userId: "user_123",
accessToken: jwt,
);
// Drop in a prebuilt Inbox widget
CourierInbox(
onMessageClick: (message, _) {
message.isRead ? message.markAsUnread() : message.markAsRead();
},
)
Documentation
Full documentation lives at courier.com/docs/sdk-libraries/flutter — installation, authentication, push setup (iOS CourierFlutterDelegate + Android Firebase decoupling), theming, custom UI, and the CourierClient API reference.
Feedback
Found a bug or want to request a feature? Open an issue.
Libraries
- client/brand_client
- client/courier_client
- client/inbox_client
- client/preference_client
- client/token_client
- client/tracking_client
- courier_api_urls
- courier_backend_urls
- courier_flutter
- courier_flutter_channels
- courier_preference_channel
- courier_preference_status
- courier_provider
- ios_foreground_notification_presentation_options
- models/courier_authentication_listener
- models/courier_brand
- models/courier_device
- models/courier_inbox_listener
- models/courier_inbox_messages
- models/courier_pagination
- models/courier_push_listener
- models/courier_tracking_event
- models/courier_user_preferences
- models/inbox_action
- models/inbox_feed
- models/inbox_message
- models/inbox_message_set
- notification_permission_status
- semantic_property
- ui/courier_background
- ui/courier_theme
- ui/courier_theme_builder
- ui/inbox/courier_inbox
- ui/inbox/courier_inbox_list_item
- ui/inbox/courier_inbox_pagination_item
- ui/inbox/courier_inbox_theme
- ui/inbox/swipable_container
- ui/preferences/courier_preferences
- ui/preferences/courier_preferences_list_item
- ui/preferences/courier_preferences_section
- ui/preferences/courier_preferences_sheet
- ui/preferences/courier_preferences_theme
- utils