Push Notification

Use the Push Notification app to send push-notification messages through Apple Push Notification Services, Firebase Cloud Messaging, Google Cloud Messages, or Windows Push Notification Services.

Before you begin

Have the credentials and device information required by the service you plan to configure. Keep credentials, certificate files, API keys, and device tokens private.

Functions

iOS Push

Use iOS Push to send notifications with Apple Push Notification Services.

Parameters

Parameter	Usage	Required
App Passphrase (iOS)	Passphrase used to access the Apple private certificate, when the certificate requires one.	No
Apple Certificate Authority File (iOS)	Certificate authority file used to establish trust with Apple Push Notification Services.	No
Apple Private Certificate File (iOS)	Private certificate file used to authenticate the app with Apple Push Notification Services.	No
Device Token (iOS)	Token that identifies the destination app installation on an iOS device.	No
Server	Apple Push Notification Services environment to use, such as development or production.	Yes
Application name	Identifier of the iOS application that will receive the notification.	No
Custom property	Additional application-specific data to include with the notification.	No
Sound	Sound the device should play when it receives the notification.	No
Badge	Value to display on the app icon badge.	No
Time to live	Length of time the notification remains eligible for delivery.	No

Response parameters

Parameter	Usage
log	Indicates whether the notification was sent successfully.
message	The output message.
error	Error message if the notification failed.

Android Firebase Cloud Messaging

Use Android Firebase Cloud Messaging to send notifications through Firebase Cloud Messaging.

Parameters

Parameter	Usage	Required
FCM Server API Key	Authenticates requests sent to Firebase Cloud Messaging.	Yes
To	Identifies a single recipient, notification topic, or device group.	No
Registration ids	Identifies multiple destination devices in one request.	No
Condition	Defines a logical expression for targeting devices subscribed to specific topics.	No
Collapse key	Groups replaceable messages so only the most recent pending message is delivered.	No
Priority	Controls the delivery priority of the message.	No
Content available	Indicates that the notification can trigger a background update.	No
Mutable Content	Allows a notification service extension to modify the notification before it is displayed.	No
Time to live	Defines how long an undelivered message remains eligible for delivery.	No
Restricted package name	Limits delivery to an app whose package name matches the specified value.	No
Dry run	Validates the request without delivering the notification.	No
Data Key1	Defines the key for the first custom data entry.	No
Data Value 1	Defines the value associated with Data Key1.	No
Data Key 2	Defines the key for the second custom data entry.	No
Data Value 2	Defines the value associated with Data Key 2.	No
Data Key 3	Defines the key for the third custom data entry.	No
Data Value 3	Defines the value associated with Data Key 3.	No
Title	Sets the notification title shown to the recipient.	Yes
Body	Sets the main notification message shown to the recipient.	Yes
Sound	Specifies the sound to play when the notification arrives.	No
Tag	Assigns an identifier that can be used to replace an existing notification.	No
Color	Sets the notification icon color on supported devices.	No
Click Action	Specifies the action to perform when the recipient opens the notification.	No
Body loc key	Identifies the localized string resource used for the notification body.	No
Title loc key	Identifies the localized string resource used for the notification title.	No

Response parameters

Parameter	Usage
multicast_id	Identifies the multicast message returned by Firebase Cloud Messaging.
success	Reports the number of messages that Firebase Cloud Messaging processed successfully.
failure	Reports the number of messages that Firebase Cloud Messaging could not process.
canonical_ids	Reports how many recipients have a canonical registration token that should replace the submitted token.
results	Contains the collection of results returned for the notification recipients.
results.0	Contains the first recipient result in the results collection.
results.0.message_id	Identifies the successfully processed message for the first recipient.
results.0.error	Contains the delivery error returned for the first recipient, when applicable.

Android Push

Use Android Push to send notifications through Google Cloud Messages.

Parameters

Parameter	Usage	Required
Ticker Text	Sets the brief text displayed in the device status bar when the notification arrives.	Yes
Title	Sets the notification title shown to the recipient.	Yes
Message	Sets the main notification message shown to the recipient.	Yes
GCM Server API Key (Android)	Authenticates requests sent to Google Cloud Messages.	Yes
Device Token (Android)	Identifies the destination app installation on an Android device.	Yes

Response parameters

Parameter	Usage
multicast_id	Identifies the multicast message returned by the push-notification service.
success	Reports the number of messages processed successfully.
failure	Reports the number of messages that could not be processed.
canonical_ids	Reports how many recipients have a canonical registration token that should replace the submitted token.
results	Contains the collection of results returned for the notification recipients.
results.registration_id	Contains the replacement registration token for a recipient, when one is returned.
results.message_id	Identifies a successfully processed message.
log	Contains log information produced while processing the request.
message	Contains a response or status message from the function.
error	Contains error information when the function cannot complete successfully.

Windows Push

Use Windows Push to send notifications through Windows Push Notification Services.

Parameters

Parameter	Usage	Required
Device Token (Windows)	Identifies the destination app installation or notification channel on a Windows device.	Yes
Title	Sets the notification title shown to the recipient.	Yes
Message	Sets the main notification message shown to the recipient.	Yes

Response parameters

Parameter	Usage
X-SubscriptionStatus	Reports the status of the destination notification subscription.
X-NotificationStatus	Reports how Windows Push Notification Services handled the notification.
X-DeviceConnectionStatus	Reports the connection status of the destination device.
log	Contains log information produced while processing the request.
message	Contains a response or status message from the function.
error	Contains error information when the function cannot complete.