Firebase Cloud Messaging (FCM)

info

Before you begin, ensure that you have created a Firebase project. If you haven't done so already, create a new project here.

Setup

To set up Courier with Firebase FCM integration, follow these steps:

Configure FCM Provider

In your Firebase Project, go to "Project Settings" > "Service Accounts" and generate a new private key.
Copy the contents of the downloaded private key JSON file and paste it into the designated field in the Courier FCM Provider Configuration.
Click "Install Provider" or "Save" to complete the configuration.

Enable iOS Support (if required)

Integrate Firebase into your iOS project.
In your Firebase project settings, go to "Cloud Messaging" and select your iOS project under "Apple app configuration".
Create a new key in your Apple Developer Account with "Apple Push Notifications Service (APNs)" enabled.
Download the generated .p8 file and upload it to your Firebase project settings under "Apple apps" > your app > "APNs Authentication Key".

Getting FCM Tokens

Using a Courier Mobile SDK

The recommended approach to set up Firebase Cloud Messaging (FCM) with Courier is to use a Courier Mobile SDK. All Courier Mobile SDKs automatically sync FCM tokens to Courier and manage them for you. This allows you to send push notifications directly to a user_id instead of managing FCM tokens manually.

Mobile SDK	FCM Token Management	Tracking Analytics
Android	Setup	Automatic
iOS	Setup	Automatic
React Native	Setup	Automatic
Flutter	Setup	Automatic

Without a Courier Mobile SDK

If you choose not to use a Courier Mobile SDK, follow the Firebase Cloud Messaging Setup guide for your desired platform.

Example FCM token:

dYeufxa20kwFnykCny-gIN:APA91bEJxheJmH_zDvoHfPsCDZstJcuYfWuQrhztywoejlAK5HmDBEYNm7R8fNzk3bjQ3lPmkVi8uaoIX94SMV4ZXRPxG_IhfT_OkfmVHCAN6GtdAvELOXSjp6z1UHVVmMnAFTOa7YxW

Manual Implementation Requirements

When implementing FCM without a Courier Mobile SDK, you will need to:

Sync, store, and manage your users' FCM tokens. This may require creating entries in your database, deploying separate endpoints, and adding extra development time that can be avoided by using a Courier Mobile SDK.
Manually make a request to the trackingUrl if you want Courier delivery and click tracking.

Sending Messages

Here's a common example request you can make to the send API, demonstrating:

providers.firebase-fcm.override.body.data.YOUR_CUSTOM_KEY for adding custom data to your payload. This is typically used for opening a specific screen in your app when the user interacts with a push notification. Firebase requires the data key to be flat. More details about FCM custom data can be found here.
providers.firebase-fcm.override.body.apns for applying iOS-specific values. You can learn more about these here.

ClickAction and Data Mapping

In order to pass a click action link into your push notification, you will need to enable the data mapping toggle in the Push channel settings.

Data mapping enabled

You can then perform a send request that looks similar to this, passing the clickAction in the data payload.

{
  "message": {
    "to": {
      "user_id": "mike_mill_made_it"
    },
    "template": "HY59FFJQTR4JGEGT25HQD2D201GK",
    "data": {
      "click_action": "https://courier.com"
    }
  }
}

Push Sound & Badging

Sounds and badges can only be configured in the override schema of a send request at this time, and are not compatible with a template field attached. If your push notifications require sounds and badges, then we recommend shaping your push request with sound and badge in the override as shown below.

Sending to a `user_id` (Recommended)

curl --request POST \
  --url https://api.courier.com/send \
  --header 'Authorization: Bearer YOUR_AUTH_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
	{
		"message": {
			"to": {
				"user_id": "YOUR_USER_ID"
			},
			"content": {
				"title": "Hey there 👋",
				"body": "Have a great day 😁"
			},
			"routing": {
				"method": "all",
				"channels": [
					"firebase-fcm"
				]
			},
			"providers": {
				"firebase-fcm": {
					"override": {
						"body": {
							"data": {
								"YOUR_CUSTOM_KEY": "YOUR_CUSTOM_VALUE"
							},
							"apns": {
								"payload": {
									"aps": {
										"sound": "ping.aiff",
										"badge": 99
									}
								}
							}
						}
					}
				}
			}
		}
	}
}'

Sending to a `firebaseToken`

curl --request POST \
  --url https://api.courier.com/send \
  --header 'Authorization: Bearer YOUR_AUTH_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
	{
		"message": {
			"to": {
				"firebaseToken": "YOUR_FCM_TOKEN"
			},
			"content": {
				"title": "Hey there 👋",
				"body": "Have a great day 😁"
			},
			"routing": {
				"method": "all",
				"channels": [
					"firebase-fcm"
				]
			},
			"providers": {
				"firebase-fcm": {
					"override": {
						"body": {
							"data": {
								"YOUR_CUSTOM_KEY": "YOUR_CUSTOM_VALUE"
							},
							"apns": {
								"payload": {
									"aps": {
										"sound": "ping.aiff",
										"badge": 99
									}
								}
							}
						}
					}
				}
			}
		}
	}
}'

Sending to multiple `firebaseTokens`

curl --request POST \
  --url https://api.courier.com/send \
  --header 'Authorization: Bearer YOUR_AUTH_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
	{
		"message": {
			"to": {
				"firebaseToken": ["FCM_TOKEN_ONE", "FCM_TOKEN_TWO"]
			},
			"content": {
				"title": "Hey there 👋",
				"body": "Have a great day 😁"
			},
			"routing": {
				"method": "all",
				"channels": [
					"firebase-fcm"
				]
			},
			"providers": {
				"firebase-fcm": {
					"override": {
						"body": {
							"data": {
								"YOUR_CUSTOM_KEY": "YOUR_CUSTOM_VALUE"
							},
							"apns": {
								"payload": {
									"aps": {
										"sound": "ping.aiff",
										"badge": 99
									}
								}
							}
						}
					}
				}
			}
		}
	}
}'

Automatic Courier Mobile SDK Formatting

When working with a working with a Courier Mobile SDK, Courier can automatically format the FCM payload to provide a better developer experience. You can toggle this feature in the Courier FCM Provider Configuration.

When enabled, this feature:

Automatically delivers Android push notifications in the background. This allows for more accurate push notification delivery tracking and the ability to use your own custom Android notification style consistently.
Supports Courier's iOS Notification Service Extension for improved push notification delivery tracking.

Here is an example of what the formatted send request looks like when this setting is enabled:

curl --request POST \
  --url https://api.courier.com/send \
  --header 'Authorization: Bearer YOUR_AUTH_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
	"message": {
		"to": {
			"user_id": "YOUR_USER_ID"
		},
		"content": {
			"title": "Hey there 👋",
			"body": "Have a great day 😁"
		},
		"routing": {
			"method": "all",
			"channels": [
				"firebase-fcm"
			]
		},
		"firebase-fcm": {
			"override": {
				"notification": null, // Prevents Android system tray from taking over notification presentation
				"data": { // Used by Courier Android SDK to present your customized notification and track notification delivery in all Android states
					"title": "Hey there 👋",
					"body": "Have a great day 😁"
				},
				"apns": {
					"payload": {
						"aps": {
							"mutable-content": 1, // Used by the Courier iOS SDK Notification Service Extension
							"sound": "ping.aiff", // Provides a default sound or vibration if iOS device ringer is off
							"alert": {
								"title": "Hey there 👋",
								"body": "Have a great day 😁"
							}
						}
					}
				}
			}
		}
	}
}'

Setup​

Configure FCM Provider​

Enable iOS Support (if required)​

Getting FCM Tokens​

Using a Courier Mobile SDK​

Without a Courier Mobile SDK​

Sending Messages​

ClickAction and Data Mapping​

Sending to a user_id (Recommended)​

Sending to a firebaseToken​

Sending to multiple firebaseTokens​

Automatic Courier Mobile SDK Formatting​