NotificationMessagePayload

Interface representing an FCM legacy API notification message payload. Notification messages let developers send up to 4KB of predefined key-value pairs. Accepted keys are outlined below.

See Build send requests for code samples and detailed documentation.

Hierarchy

NotificationMessagePayload

Indexable

[key: string]: string | undefined

Interface representing an FCM legacy API notification message payload. Notification messages let developers send up to 4KB of predefined key-value pairs. Accepted keys are outlined below.

See Build send requests for code samples and detailed documentation.

Index

Properties

Optional badge

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

Optional body

body: string

The notification's body text.

Platforms: iOS, Android, Web

Optional bodyLocArgs

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

Optional bodyLocKey

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

Optional clickAction

clickAction: string

Action associated with a user click on the notification. If specified, an activity with a matching Intent Filter is launched when a user clicks on the notification.

Platforms: Android

Optional color

color: string

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

Platforms: Android

Optional icon

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

Optional sound

sound: 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

Optional tag

tag: string

Optional title

title: string

The notification's title.

Platforms: iOS, Android, Web

Optional titleLocArgs

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

Optional titleLocKey

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