Set up Amplify Push Notifications

The Push Notifications category allows you to integrate push notifications in your app with Amazon Pinpoint targeting, campaign, and journey management support. You can segment your users, trigger push notifications to your app, and record metrics in Pinpoint when users receive or open notifications. Amazon Pinpoint helps you to create messaging campaigns and journeys targeted to specific user segments or demographics and collect interaction metrics with push notifications.

Prerequisites

You should have completed the CLI and project setup steps.

id "com.google.gms:google-services" version "4.3.14" apply false

Set up backend resources

To use Push Notifications with Amplify, you have the option to either have the Amplify CLI setup resources for you, or you can use an existing Amazon Pinpoint resource in your AWS account.

amplify add notifications

? Choose the push notification channel to enable.
❯ APNS |  Apple Push Notifications
  FCM  | » Firebase Push Notifications
  In-App Messaging
  Email
  SMS

? Provide your pinpoint resource name: › [pinpoint_resource_name]
? Apps need authorization to send analytics events. Do you want to allow guests
 and unauthenticated users to send analytics events? (we recommend you allow this 
 when getting started) (Y/n)

? Choose authentication method used for APNs
> Certificate
Key

🛑 Command failed: openssl pkcs12 -in [path_to_your_cert].p12 -out [output_path].pem -nodes -passin pass:
Error outputting keys and certificates

? Choose the push notification channel to enable.
  APNS |  Apple Push Notifications
❯ FCM  | » Firebase Push Notifications
  In-App Messaging
  Email
  SMS

? Provide your pinpoint resource name:
    `yourPinpointResourceName`

? Apps need authorization to send analytics events. Do you want to allow guests and unauthenticated users to send analytics events? (we recommend you allow this when getting started) (Y/n)
    'Y'

{
  "notifications": {
    "plugins": {
      "awsPinpointPushNotificationsPlugin": {
        "appId": "<app-id>",
        "region": "<region>"
      }
    }
  }
}

Install Amplify Libraries

In your project directory, you should first install the necessary dependencies for using Amplify Push Notifications.

1. Open pubspec.yaml at the root of your Flutter project with a text editor.

2. Add the necessary libraries into the dependencies block:

dependencies:
  amplify_auth_cognito: ^2.0.0
  amplify_flutter: ^2.0.0
  amplify_push_notifications_pinpoint: ^2.0.0
  flutter:
    sdk: flutter

Initialize Amplify Push Notifications

To initialize Amplify Push Notifications, you will need to configure Amplify add the Auth and Push Notifications plugins. To complete initialization, call Amplify.configure

Your resulting code should look something like the following:

// Example main.dart

import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_flutter/amplify_flutter.dart';
import 'package:amplify_push_notifications_pinpoint/amplify_push_notifications_pinpoint.dart';

import 'amplifyconfiguration.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    _configureAmplify();
  }

  Future<void> _configureAmplify() async {
    try {
      final authPlugin = AmplifyAuthCognito();
      final pushPlugin = AmplifyPushNotificationsPinpoint();
      await Amplify.addPlugins([authPlugin, pushPlugin]);
      await Amplify.configure(amplifyconfig);
    } on Exception catch (e) {
      safePrint('An error occurred configuring Amplify: $e');
    }
  }

  @override
  Widget build(BuildContext context) {
    // Your application UI
  }
}