[ Web Proxy ]
URL:
Viewing: https://firebase.google.com/docs/reference/js/messaging_.messagepayload [Back]  [Original]
MessagePayload interface  |  Firebase JavaScript API reference Skip to main content
Firebase [Firebase]
Build Run Solutions Pricing Docs Support
Search:
Blog Go to console
Overview Fundamentals AI Build Run Reference Samples
Firebase [Firebase]
Send feedback

MessagePayload interface Stay organized with collections Save and categorize content based on your preferences.

Message payload that contains the notification payload that is represented with NotificationPayload and the data payload that contains an arbitrary number of key-value pairs sent by developers through the Send API.

Signature:

export interface MessagePayload

Properties

Property Type Description
collapseKey string The collapse key of the message. See Non-collapsible and collapsible messages
data { [key: string]: string; } Arbitrary key/value payload.
fcmOptions FcmOptions Options for features provided by the FCM SDK for Web. See WebpushFcmOptions.
from string The sender of this message.
messageId string The message ID of a message.
notification NotificationPayload Display notification details. Details are sent through the Send API.

MessagePayload.collapseKey

The collapse key of the message. See Non-collapsible and collapsible messages

Signature:

collapseKey: string;

MessagePayload.data

Arbitrary key/value payload.

Signature:

data?: {
        [key: string]: string;
    };

MessagePayload.fcmOptions

Options for features provided by the FCM SDK for Web. See WebpushFcmOptions.

Signature:

fcmOptions?: FcmOptions;

MessagePayload.from

The sender of this message.

Signature:

from: string;

MessagePayload.messageId

The message ID of a message.

Signature:

messageId: string;

MessagePayload.notification

Display notification details. Details are sent through the Send API.

Signature:

notification?: NotificationPayload;
Send feedback

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-09 UTC.

Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-09 UTC."],[],[]]
Web Proxy Viewer  |  New URL  |  Original Page