firebase_cloud_messaging_dart #

A pure Dart library for sending Firebase Cloud Messages and managing topics via the FCM HTTP v1 API. Works in any Dart environment — backend servers, CLI tools, Serverpod, or Flutter.

Tip

Found an issue? Please open an issue on GitHub.

Features #

Pure Dart — no Firebase SDK dependency, works anywhere Dart runs
FCM HTTP v1 API — full spec compliance, verified against the official discovery document
All platforms — typed configs for Android, APNs (iOS/macOS), and Web Push
Application Default Credentials (ADC) — seamless auth on Cloud Run, App Engine, Firebase Functions
Topic management — subscribe/unsubscribe tokens via the Instance ID API
Parallel delivery — sendToMultiple and sendMessages fan out via Future.wait
Automatic retries — exponential backoff for QUOTA_EXCEEDED, UNAVAILABLE, and INTERNAL errors
Typed error handling — FcmError with FcmErrorCode enum for programmatic error handling
Dart 3 — sealed classes, records, pattern matching, exhaustive switch

Getting Started #

1. Install #

dependencies:
  firebase_cloud_messaging_dart: ^3.0.2

2. Get credentials #

Go to Firebase Console > Project Settings > Service Accounts > Generate new private key.
Save the downloaded file as serviceAccountKey.json in your project root (next to pubspec.yaml):

my_app/
├── lib/
├── pubspec.yaml
├── serviceAccountKey.json   <-- place it here
└── .gitignore

Add it to .gitignore immediately:

# .gitignore
serviceAccountKey.json

Caution

Never commit serviceAccountKey.json to version control. It grants full admin access to your Firebase project.

Initialization #

import 'package:firebase_cloud_messaging_dart/firebase_cloud_messaging_dart.dart';

Four ways to create a server instance:

// From a file path (simplest)
final server = FirebaseCloudMessagingServer.fromServiceAccountFile(
  'serviceAccountKey.json',
);

// From a File object
final server = FirebaseCloudMessagingServer.fromServiceAccountFile(
  File('serviceAccountKey.json'),
);

// From a JSON string
final server = FirebaseCloudMessagingServer.fromServiceAccountJson(
  await File('serviceAccountKey.json').readAsString(),
);

// From a parsed Map
final server = FirebaseCloudMessagingServer(jsonDecode(jsonString));

// Application Default Credentials (Cloud Run, App Engine, Firebase Functions)
final server = FirebaseCloudMessagingServer.applicationDefault(
  projectId: 'my-project-id',
);

All constructors accept these optional parameters:

Parameter	Type	Default	Description
`cacheAuth`	`bool`	`true`	Reuse OAuth token until it expires (~1 hour)
`logger`	`FcmLogger`	`fcmSilentLogger`	Logging callback
`retryConfig`	`FcmRetryConfig`	3 retries, 1s initial delay	Retry behavior for transient errors
`onRegistrationChange`	`FcmRegistrationCallback?`	`null`	Fires when a token is confirmed active or found unregistered
`httpClient`	`http.Client?`	`null`	Custom HTTP client (useful for testing)

Sending Messages #

Single device #

final result = await server.send(
  FirebaseSend(
    message: FirebaseMessage(
      token: 'device-token',
      notification: FirebaseNotification(
        title: 'Hello',
        body: 'World',
        image: 'https://example.com/image.png',
      ),
    ),
  ),
);

switch (result) {
  case ServerSuccess(:final messageSent):
    print('Sent: ${messageSent.name}');
  case ServerFailure(:final fcmError):
    print('Error: ${fcmError?.errorCode}');
}

Multiple tokens (same message, parallel) #

Equivalent to the Admin SDK's sendEachForMulticast. Fans out in parallel via Future.wait.

final batch = await server.sendToMultiple(
  tokens: ['token_a', 'token_b', 'token_c'],
  messageTemplate: FirebaseMessage(
    notification: FirebaseNotification(title: 'Update available'),
  ),
);

print('${batch.successCount} succeeded, ${batch.failureCount} failed');

// Clean up stale tokens
for (final res in batch.failedResults) {
  if (res.serverResult.fcmError?.errorCode == FcmErrorCode.unregistered) {
    await db.removeToken(res.token);
  }
}

BatchResult provides: successCount, failureCount, successfulResults, failedResults, allSuccessful, anySuccessful.

Multiple distinct messages (parallel) #

Equivalent to the Admin SDK's sendEach. Each message can have a different target and payload.

final results = await server.sendMessages([
  FirebaseSend(
    message: FirebaseMessage(
      token: 'token_a',
      notification: FirebaseNotification(title: 'Message for A'),
    ),
  ),
  FirebaseSend(
    message: FirebaseMessage(
      token: 'token_b',
      data: {'action': 'sync'},
    ),
  ),
]);

for (final result in results) {
  print('${result.successful ? "OK" : "FAIL"}: ${result.statusCode}');
}

Send to topic #

final result = await server.sendToTopic(
  'breaking-news',
  FirebaseMessage(
    notification: FirebaseNotification(title: 'Breaking News!'),
  ),
);

Send to condition #

final result = await server.sendToCondition(
  "'sports' in topics || 'news' in topics",
  FirebaseMessage(
    notification: FirebaseNotification(title: 'Sports & News'),
  ),
);

Both sendToTopic and sendToCondition accept an optional validateOnly parameter for dry-run validation.

Validate without sending #

final result = await server.validateMessage(
  FirebaseSend(
    message: FirebaseMessage(
      token: 'some-token',
      notification: FirebaseNotification(title: 'Test'),
    ),
  ),
);

if (!result.successful) {
  print('Invalid payload: ${result.fcmError?.message}');
}

Topic Management #

Subscribe and unsubscribe tokens using the Firebase Instance ID API (up to 1,000 tokens per call).

// Subscribe
final subResult = await server.subscribeTokensToTopic(
  topic: 'news',
  tokens: ['token1', 'token2', 'token3'],
);
print('Subscribed: ${subResult.successCount}/${subResult.results.length}');

// Unsubscribe
final unsubResult = await server.unsubscribeTokensFromTopic(
  topic: 'news',
  tokens: ['token1'],
);

TopicManagementResult provides: successCount, failureCount, results (per-token), allSuccessful, failedResults.

Each TopicManagementTokenResult has: token, successful, error.

Platform-Specific Configuration #

Android #

FirebaseMessage(
  token: 'device-token',
  notification: FirebaseNotification(title: 'Hello'),
  android: FirebaseAndroidConfig(
    priority: AndroidMessagePriority.high,
    ttl: '86400s',
    collapseKey: 'updates',
    directBootOk: true,
    bandwidthConstrainedOk: true,
    restrictedSatelliteOk: false,
    fcmOptions: AndroidFcmOptions(analyticsLabel: 'android_campaign'),
    notification: FirebaseAndroidNotification(
      channelID: 'high_priority',
      icon: 'ic_notification',
      color: '#FF5733',
      sound: 'default',
      tag: 'message-group-1',
      clickAction: 'OPEN_CHAT',
      image: 'https://example.com/banner.png',
      notificationPriority: NotificationPriority.priorityHigh,
      visibility: Visibility.public,
      sticky: false,
      notificationCount: 3,
      lightSettings: LightSettings(
        color: FCMColor(red: 0.0, green: 1.0, blue: 0.0, alpha: 1.0),
        lightOnDuration: '0.5s',
        lightOffDuration: '1.0s',
      ),
      proxy: AndroidNotificationProxy.ifPriorityLowered,
    ),
  ),
)

AndroidMessagePriority — normal, high

NotificationPriority — priorityUnspecified, priorityMin, priorityLow, priorityDefault, priorityHigh, priorityMax

Visibility — visibilityUnspecified, private, public, secret

AndroidNotificationProxy — proxyUnspecified, allow, deny, ifPriorityLowered

APNs (iOS / macOS) #

FirebaseMessage(
  token: 'device-token',
  apns: FirebaseApnsConfig(
    headers: {'apns-priority': '10'},
    notification: FirebaseApnsNotification(
      title: 'New Message',
      body: 'You have a new message',
      sound: 'default',
      badge: 1,
      category: 'MESSAGE',
      threadId: 'chat-123',
      contentAvailable: 1,
      mutableContent: 1,
      interruptionLevel: InterruptionLevel.timeSensitive,
      relevanceScore: 0.8,
      alert: ApnsAlert(
        title: 'Structured Alert',
        subtitle: 'With subtitle',
        body: 'Full alert body',
        titleLocKey: 'TITLE_KEY',
        titleLocArgs: ['arg1'],
        locKey: 'BODY_KEY',
        locArgs: ['arg1', 'arg2'],
      ),
    ),
    fcmOptions: ApnsFcmOptions(
      analyticsLabel: 'ios_campaign',
      image: 'https://example.com/ios-image.png',
    ),
    payload: {'custom_key': 'custom_value'},
  ),
)

InterruptionLevel — active, critical, passive, timeSensitive

Web Push #

FirebaseMessage(
  token: 'device-token',
  webpush: FirebaseWebpushConfig(
    headers: {'Urgency': 'high', 'TTL': '86400'},
    data: {'click_url': 'https://example.com/page'},
    notification: FirebaseWebpushNotification(
      title: 'New Update',
      body: 'Check it out',
      icon: 'https://example.com/icon.png',
      badge: 'https://example.com/badge.png',
      image: 'https://example.com/banner.png',
      tag: 'update-1',
      requireInteraction: true,
      silent: false,
      renotify: true,
      dir: WebpushDirection.ltr,
      lang: 'en',
      vibrate: [200, 100, 200],
      actions: [
        WebpushAction(
          action: 'open',
          title: 'Open',
          icon: 'https://example.com/open.png',
        ),
        WebpushAction(
          action: 'dismiss',
          title: 'Dismiss',
        ),
      ],
    ),
    fcmOptions: WebpushFcmOptions(
      link: 'https://example.com',
      analyticsLabel: 'web_campaign',
    ),
  ),
)

WebpushDirection — auto, ltr, rtl

Cross-Platform Options #

FirebaseMessage(
  token: 'device-token',
  notification: FirebaseNotification(
    title: 'Cross-Platform Title',
    body: 'Applies to all platforms',
    image: 'https://example.com/image.png',
  ),
  data: {'key': 'value'},
  fcmOptions: FirebaseFcmOptions(analyticsLabel: 'campaign_v2'),
)

Error Handling #

Every send returns a ServerResult — a sealed class with two subtypes:

switch (result) {
  case ServerSuccess(:final messageSent):
    print('Message ID: ${messageSent.name}');
  case ServerFailure(:final fcmError, :final statusCode):
    print('HTTP $statusCode: ${fcmError?.message}');
    print('Retryable: ${fcmError?.isRetryable}');
}

FCM Error Codes #

Code	HTTP	Retryable	Meaning
`unregistered`	404	No	Token is no longer valid — remove from database
`senderIdMismatch`	403	No	Token doesn't match this project
`invalidArgument`	400	No	Bad payload or invalid JSON
`quotaExceeded`	429	Yes	Rate limit hit — backoff and retry
`unavailable`	503	Yes	FCM temporarily unavailable
`internal`	500	Yes	FCM server error — retry with backoff
`thirdPartyAuthError`	401	No	APNs cert or web push auth key invalid
`unknown`	—	No	Unrecognized error code

Token Registration Callback #

Automatically detect invalid tokens without checking every result:

final server = FirebaseCloudMessagingServer(
  credentials,
  onRegistrationChange: (String token, FcmRegistrationStatus status) {
    switch (status) {
      case FcmRegistrationStatus.active:
        print('$token confirmed active');
      case FcmRegistrationStatus.unregistered:
        print('$token is invalid — removing');
        db.removeToken(token);
    }
  },
);

The callback only fires unregistered for permanent failures (UNREGISTERED, SENDER_ID_MISMATCH). Transient errors like QUOTA_EXCEEDED or UNAVAILABLE do not trigger it.

Retry Configuration #

Retryable errors (QUOTA_EXCEEDED, UNAVAILABLE, INTERNAL) are automatically retried with exponential backoff.

final server = FirebaseCloudMessagingServer(
  credentials,
  retryConfig: FcmRetryConfig(
    maxRetries: 5,
    initialDelay: Duration(seconds: 2),
    maxDelay: Duration(seconds: 60),
  ),
);

Backoff formula: 2^attempt * initialDelay, capped at maxDelay.

Attempt	Delay (with defaults)
0	1s
1	2s
2	4s
3	8s

To disable retries:

retryConfig: FcmRetryConfig.none

Logging #

Integrate with any logging framework:

final server = FirebaseCloudMessagingServer(
  credentials,
  logger: (FcmLogLevel level, String message, {Object? error, StackTrace? stackTrace}) {
    print('[FCM ${level.name}] $message');
    if (error != null) print('  Error: $error');
  },
);

Log levels: debug, info, warning, error.

Data-Only Messages #

Send silent background data without showing a notification:

final result = await server.send(
  FirebaseSend(
    message: FirebaseMessage(
      token: 'device-token',
      data: {
        'action': 'sync',
        'timestamp': DateTime.now().toIso8601String(),
      },
    ),
  ),
);

Resource Cleanup #

Always dispose when done to close the underlying HTTP client:

server.dispose();

Complete API Reference #

FirebaseCloudMessagingServer #

Method	Returns	Description
`send(FirebaseSend)`	`Future<ServerResult>`	Send a single message
`sendToMultiple(tokens, messageTemplate, {validateOnly})`	`Future<BatchResult>`	Same message to many tokens (parallel)
`sendMessages(List<FirebaseSend>)`	`Future<List<ServerResult>>`	Distinct messages (parallel)
`sendToTopic(topic, message, {validateOnly})`	`Future<ServerResult>`	Send to topic subscribers
`sendToCondition(condition, message, {validateOnly})`	`Future<ServerResult>`	Send to condition match
`validateMessage(FirebaseSend)`	`Future<ServerResult>`	Dry-run validation
`subscribeTokensToTopic(topic, tokens)`	`Future<TopicManagementResult>`	Subscribe up to 1,000 tokens
`unsubscribeTokensFromTopic(topic, tokens)`	`Future<TopicManagementResult>`	Unsubscribe up to 1,000 tokens
`dispose()`	`void`	Close HTTP client

Message Models #

Class	Purpose
`FirebaseSend`	Request wrapper with `validateOnly` flag
`FirebaseMessage`	Core message: target + notification + data + platform configs
`FirebaseNotification`	Cross-platform title, body, image
`FirebaseFcmOptions`	Cross-platform analytics label

Platform Configs #

Class	Platform
`FirebaseAndroidConfig`	Android delivery settings
`AndroidFcmOptions`	Android analytics label
`FirebaseAndroidNotification`	Android visual notification (42 fields)
`LightSettings`	Android LED configuration
`FCMColor`	RGBA color (0.0-1.0 floats)
`FirebaseApnsConfig`	APNs delivery settings
`FirebaseApnsNotification`	APNs APS dictionary
`ApnsAlert`	Structured iOS alert
`ApnsFcmOptions`	APNs analytics label + image
`FirebaseWebpushConfig`	Web Push delivery settings
`FirebaseWebpushNotification`	Web Notification API fields
`WebpushAction`	Web notification action button
`WebpushFcmOptions`	Web Push analytics label + click link

Result Types #

Class	Purpose
`ServerResult`	Sealed base: `ServerSuccess` or `ServerFailure`
`BatchResult`	Aggregated multi-token result
`TokenResult`	Single token outcome within a batch
`TopicManagementResult`	Aggregated topic operation result
`TopicManagementTokenResult`	Single token outcome within a topic operation
`FcmError`	Structured FCM error with typed `FcmErrorCode`

Configuration #

Class	Purpose
`FcmRetryConfig`	Retry behavior (max retries, delays)
`FirebaseServiceModel`	Parsed service account JSON fields

Contributing #

Contributions are welcome! See CONTRIBUTING.md for guidelines.

License #

BSD 3-Clause License. See LICENSE for details.

firebase_cloud_messaging_dart 3.0.2 firebase_cloud_messaging_dart: ^3.0.2 copied to clipboard

Metadata