Skip to content
RallyHere Docs
GitHub

Create Session Event

POST
/session/v1/session/{session_id}/event

Create an event in the log for this session. Internal session operations will create new events that are accessible from the get request.

Player clients and instances are expected to create events here when something occurs on their clients that is relevant.

Required Permissions: For any player (including themselves)any of: session:update:any, session:*, session:update:event

Required Session Permissions: None

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters

Request Body required

A request body to create an event about a session

object
event_code
required

Code that identifies this type of event. See CommonEventCode for common examples.

string
>= 1 characters <= 256 characters
description

Description metadata about the event

string
"" <= 4096 characters
custom_data

Custom data about this event

object
key
additional properties
string
>= 1 characters <= 4096 characters
timestamp
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

Responses

200

Successful Response

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Session doesn’t exist. See error code for more info

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string