Write Player Event
Writes a player-based event into PlayStream.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| InvalidEventField | 1216 |
| NoWritePermissionsForEvent | 1207 |
| ProductDisabledForTitle | 1609 |
| UserisNotValid | 1030 |
Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
This API is designed to write a multitude of different event types into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any player-based event. The created event will be locked to the authenticated title.
This API is designed to write a multitude of different event types into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any player-based event. The created event will be locked to the authenticated title.
The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).
Unique PlayFab assigned ID of the user on whom the operation will be performed.
Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object).
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The time (in UTC) associated with this event. The value defaults to the current time.
