Properties

badge

string

The value of the badge on the home screen app icon.

If not specified, the badge is not changed.

If set to 0, the badge is removed.

Platforms: iOS

body

string

The notification's body text.

Platforms: iOS, Android, Web

bodyLocArgs

string

Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.

The value should be a stringified JSON array.

iOS: Corresponds to loc-args in the APNs payload. See Payload Key Reference and Localizing the Content of Your Remote Notifications for more information.

Android: See Formatting and Styling for more information.

Platforms: iOS, Android

bodyLocKey

string

The key to the body string in the app's string resources to use to localize the body text to the user's current localization.

iOS: Corresponds to loc-key in the APNs payload. See Payload Key Reference and Localizing the Content of Your Remote Notifications for more information.

Android: See String Resources for more information.

Platforms: iOS, Android

clickAction

string

The action associated with a user click on the notification.

iOS: Corresponds to category in the APNs payload.

Android: If specified, an activity with a matching intent filter is launched when a user clicks on the notification.

Web: For all URL values, secure HTTPS is required.

Platforms: iOS, Android, Web

color

string

The notification icon's color, expressed in #rrggbb format.

Platforms: Android

icon

string

The notification's icon.

Android: Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest.

Web: The URL to use for the notification's icon.

Platforms: Android, Web

sound

string

The sound to play when the device receives the notification.

iOS: Sound files can be in the main bundle of the client app or in the Library/Sounds folder of the app's data container. See the iOS Developer Library for more information.

Android: Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.

Platforms: iOS, Android

tag

string

Identifier used to replace existing notifications in the notification drawer.

If not specified, each request creates a new notification.

If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.

Platforms: Android

title

string

The notification's title.

Platforms: iOS, Android, Web

titleLocArgs

string

Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.

The value should be a stringified JSON array.

iOS: Corresponds to title-loc-args in the APNs payload. See Payload Key Reference and Localizing the Content of Your Remote Notifications for more information.

Android: See Formatting and Styling for more information.

Platforms: iOS, Android

titleLocKey

string

The key to the title string in the app's string resources to use to localize the title text to the user's current localization.

iOS: Corresponds to title-loc-key in the APNs payload. See Payload Key Reference and Localizing the Content of Your Remote Notifications for more information.

Android: See String Resources for more information.

Platforms: iOS, Android