|
| 1 | +This section describes the process of setting up push notifications within the DevRev SDK. By completing this setup, users of your mobile app's support chat will receive notifications whenever a DevRev customer experience engineer responds. |
| 2 | + |
| 3 | +## Prerequisites |
| 4 | + |
| 5 | +- **Apple Developer Program access**: Required for setting up iOS push notifications. |
| 6 | +- **Google Developer Account and Firebase project**: Necessary for configuring Android push notifications. |
| 7 | +- **Access to credentials and files**: Ensure you have your Bundle ID, Team ID, and APNs/FCM keys readily available. |
| 8 | +- **Admin access to DevRev PLuG settings**: Required to configure PLuG notifications within DevRev. |
| 9 | +- **Mobile SDK integration**: Ensure that the DevRev SDK is integrated with your Android or iOS app and tested to facilitate notifications. |
| 10 | + |
| 11 | +## Configure push notifications |
| 12 | + |
| 13 | +1. Accessing PLuG Settings |
| 14 | + |
| 15 | + a. Go to **Settings** > **Support** > **PLuG settings** > **Mobile push notifications**. |
| 16 | + |
| 17 | + b. Click **+ Configure app** > and select either **iOS App** or **Android App** based on your target platform. |
| 18 | + |
| 19 | +<Callout intent="note"> |
| 20 | +If you are configuring an iOS app, proceed to step 2. For an Android app, skip to step 3. |
| 21 | +</Callout> |
| 22 | + |
| 23 | +2. iOS app configuration |
| 24 | + |
| 25 | + a. After selecting **iOS App**, fill out the configuration form: |
| 26 | + - **App name**: Enter your iOS app's name. |
| 27 | + - **Bundle ID**: Provide your app's unique identifier in reverse domain notation, such as, `com.example.app`. Refer to [Apple's documentation](https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids) to confirm your bundle ID. |
| 28 | + - **Apple Team ID**: Enter the 10-character Apple Team ID assigned to your organization. Details are available in [Apple's Team ID documentation](https://developer.apple.com/help/account/manage-your-team/locate-your-team-id/). |
| 29 | + - **Key ID**: Enter the Key ID for your APNs Auth Key. See [Apple's Key ID documentation](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for further instructions. |
| 30 | + - **Upload APNs Auth Key**: Upload the `.p8` APNs Auth Key file (maximum size: 10 MB). |
| 31 | + - **Sandbox Environment**: Check this for development environments to enable notifications in debug builds. |
| 32 | + |
| 33 | + b. Click **Save App** to complete the iOS setup. |
| 34 | + |
| 35 | +3. Android app configuration |
| 36 | + |
| 37 | + a. Select **Android App** and complete the configuration form: |
| 38 | + - **App name**: Enter your Android app's name. |
| 39 | + - **Bundle ID**: Provide your app's unique identifier in reverse domain notation, such as, `com.example.app`. Refer to [Google’s documentation](https://developer.android.com/studio/build/application-id) to confirm your bundle ID. |
| 40 | + - **Upload Service Account Key**: Upload a Service Account Key JSON file (up to 10 MB) generated via Google Cloud for Firebase Cloud Messaging (FCM). Create this key following [Google’s documentation](https://firebase.google.com/docs/). |
| 41 | + |
| 42 | + b. Click **Save App** to complete the Android setup. |
| 43 | + |
| 44 | +4. Click **Save and Publish** to activate push notifications in your DevRev SDK. |
| 45 | + |
| 46 | +Upon completing these steps, push notifications are operational in the DevRev SDK. Users engaged in your app's support chat receive real-time notifications when a DevRev customer experience engineer responds, ensuring effective and timely communication. |
| 47 | + |
| 48 | +For additional support or inquiries, refer to the latest [Apple developer documentation](https://developer.apple.com/) and [Android developer documentation](https://developer.android.com/) as guidelines may change. |
0 commit comments