Skip to content

Receive Events V1

POST
/events/v1/events

Post game events, return number of events being posted to Event Hub

Request Body required

object
event_list
required

List of events

Array<object>
object
event_uuid
required

Unique Event ID for this instance of the event

string format: uuid
event_name
required

Type of event to process this as.

string
>= 1 characters <= 128 characters
event_timestamp
required

Time the event was triggered

string format: date-time
event_params
required

Event specific parameters

object
custom_data

Event custom data

object
key
additional properties
string
user_id
Any of:
string
>= 1 characters <= 128 characters
session_id
Any of:
string
>= 1 characters <= 128 characters
correlation_id
Any of:
string
>= 1 characters <= 128 characters

Responses

200

Successful Response

object
posted_events
required

Number of events successfully posted to Event Hub

integer
errors

List of validation failure for each event.

Array

207

Error Codes:

  • events_multi_results - Some of the events from the request failed to process, and uploaded to deadletter blob storage
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

400

Error Codes:

  • events_all_failed - All of events from the request failed to process, and uploaded to deadletter blob storage
  • event_lists_invalid - The input eventLists is invalid, failed pydantic validation
  • event_unsupported - Event name is not known
  • event_denied - Events of that name are currently denied
  • event_duplicated - Event has the same event_uuid as an event already received
  • event_params_invalid - The event_params failed validation against the jsonschema defined for the type/version. See response description for more details.
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Error Codes:

  • event_schema_invalid - event_params jsonschema is empty, failed to load from developer-api
  • event_schema_not_found - The jsonschema is invalid and could not be used to validate the event_params value. See response description for more details.
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