sent_push_notification
This event is triggered when a push notification is sent or fails to be sent to a player.
Properties
| Name | Type | Description |
|---|---|---|
| Body | String | The content of the push notification body, truncated to 4096 characters. |
| ErrorMessage | String | The error that occurred if the push notification failed to be sent. |
| ErrorName | String | The name of the error that occurred if the push notification failed to be sent. |
| Language | String | The language the push notification was sent in if a matching localized template was used. |
| PushNotificationTemplateId | String | The push notification template id during a send push notification attempt. |
| PushNotificationTemplateName | String | The push notification template name during a send push notification attempt. |
| Subject | String | The content of the push notification subject, truncated to 1024 characters. |
| Success | Boolean | Indicates whether the push notification was successfully sent. |
| TitleId | String | The ID of the title to which this player event applies. |
Common Properties
All PlayStream events are formatted as JSON objects and share the following common properties:
| Name | Type | Description |
|---|---|---|
| CustomTags | Object | Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property. |
| EntityId | String | The identifier for the entity (title, player, etc) to which this event applies. |
| EntityType | String | The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time. |
| EventId | String | PlayFab-assigned unique identifier for this event. |
| EventName | String | The name of this event. |
| EventNamespace | String | The assigned namespacing for this event. For example: 'com.myprogram.ads' |
| History | PlayStreamEventHistory | The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action. |
| Reserved | object | Reserved exclusively for PlayFab internal use. |
| Source | String | The name of the source of this PlayStream event; will be PlayFab if the event originated from us. |
| SourceType | SourceType | The type of source of this event (PlayFab partner, other backend, or from the PlayFab API). |
| Timestamp | DateTime | The time (in UTC) associated with this event. |