Analytics - Write Player Event

Writes a player-based event into PlayStream.

POST https://titleId.playfabapi.com/Server/WritePlayerEvent

Request Header

Name Required Type Description
X-SecretKey True
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
EventName True
  • string

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).

PlayFabId True
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Body
  • object

Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object).

CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Timestamp
  • string

The time (in UTC) associated with this event. The value defaults to the current time.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

WriteEventResponse
WriteServerPlayerEventRequest

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.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • integer

Numerical PlayFab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the PlayFab errorCode

status
  • string

String HTTP code

WriteEventResponse

Name Type Description
EventId
  • string

The unique identifier of the event. The values of this identifier consist of ASCII characters and are not constrained to any particular format.

WriteServerPlayerEventRequest

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.

Name Type Description
Body
  • object

Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object).

CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EventName
  • string

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).

PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Timestamp
  • string

The time (in UTC) associated with this event. The value defaults to the current time.

Error Codes

Name Code
InvalidEventField 1216
NoWritePermissionsForEvent 1207
UserisNotValid 1030