Skip to content
PurrCRMPurrCRMPurrCRM Docs

The Flutter SDK

crm_sdk puts PurrCRM inside your Flutter app. You add the package, hand it your signed-in user’s token, and it does the rest:

  • In-app messages: banners, posts, carousels and surveys your team writes, shown over your app’s screens. What people do with each goes back to PurrCRM.
  • The messenger: conversations with your team, replies arriving live, pictures, ratings, a help bot, and the user’s tickets.
  • The help center: your articles, searched and read in the app.
  • Product events: the app opening and closing, screens, permission changes and taps on pushes, sent in batches by itself, plus events of your own.
  • Pushes: it recognises PurrCRM‘s pushes, keeps the unread counts right, and opens the page a tapped push names.
  • Links: links that open a page in your app on a phone that has it.
  • Preferences: a ready-made screen where people choose which topics they hear about, and how.

Your app stays in charge of signing people in, Firebase and the push permission, picking pictures, and the phone’s time zone. Each of those is a hook you hand to the package.

Requirements

Section titled “Requirements”
  • Flutter 3.47.5 or later (Dart 3.13.4 or later).
  • Your PurrCRM address, https://app.purrcrm.com, and your app’s key, from Settings › Connect › Install.
  • A backend that signs a short token for your signed-in users (Sign users in).
  • go_router 16 or 17, if you route with it. It is optional.

Where to start

Section titled “Where to start”
  1. Install the package.
  2. Initialise it in main.dart.
  3. Sign users in.
  4. Set up push.
  5. Check it works: the setup checklist on PurrCRM‘s overview ticks Install the SDK in a build when the first request from your app arrives, and Settings › Connect › Install › What your app sees shows what the package reads of your app.

Then add what you need: links, the messenger and help screens, in-app messages, events, preferences, theming, test mode and tests.

Every class and method is in the reference.