push_notification_sent - XBOX Game Development Documentation

This event is triggered when a push notification is sent to a player.

Properties

Name	Type	Description
ErrorMessage	String	The error that occurred if failed.
PushNotificationTemplateId	String	The push notification template id.
PushNotificationTemplateName	String	The friendly name of the push notification template.
Success	Boolean	Whether the push notification was sent successfully.

Common Properties

All V2 PlayStream events are formatted as JSON objects and most share the following common properties:

Name	Type	Description
SchemaVersion	String	PlayStream event format version, following a semantic versioning scheme.
FullName	Object	Combination of the event name and event namespace to fully specify the event type.
Id	String	PlayFab-assigned unique identifier for this event.
Timestamp	DateTime	The time (in UTC) associated with this event.
Entity	Object	Details about the entity to which this event applies including Entity Id and Entity type.
Originator	Object	Object describing the source and source type that initiated this event.
PayloadContentType	String	Specifies the content of the event payload. Default is “JSON”.
Origin Info	Object	Optional field containing info about events originating outside of PlayFab.

Last modified on August 3, 2026

Related topics

sent_push_notification PlayStream event model reference for PlayFab Push Notifications quickstart Push Notifications PFPushNotificationsPushNotificationPackage

⌘I