Passer au contenu principal
POST
Write Player Event

Autorisations

X-Authorization
string
header
requis

This API requires a client session ticket, available from any Client Login function.

Corps

application/json

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 and player.

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 and player.

EventName
string
requis

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

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.

Réponse

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Exemple:
Dernière modification le 6 octobre 2026