Receive Events V1

POST 
/events/v1/events

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

Request

Header Parameters

x-rh-client-addr any

IP Address hint

application/json

Body

required

event_list

object[]

required

List of events

Array [

event_uuid uuidrequired

Unique Event ID for this instance of the event

event_name Event Name (string)required

Possible values: non-empty and <= 128 characters

Type of event to process this as.

event_timestamp date-timerequired

Time the event was triggered

event_params objectrequired

Event specific parameters

custom_data

object

Event custom data

property name* string

user_id

object

User who submitted the event

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

session_id

object

Session ID to associate the event with

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

correlation_id

object

Correlation ID to associate the event with

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

client_ip

object

Client IP associated with the event

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

]

Responses

200

Successful Response

application/json

Schema

Schema

posted_events Posted Events (integer)required

Number of events successfully posted to Event Hub

errors undefined[]

list of validation failure for each event.

Example (from schema)

{
  "posted_events": 0,
  "errors": [
    null
  ]
}

207

Error Codes:

• events_multi_results - Some of the events from the request failed to process, and uploaded to deadletter blob storage

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

400

Error Codes:

• event_denied - Events of that name are currently denied

• event_duplicated - Event has the same event_uuid as an event already received

• event_lists_invalid - The input eventLists is invalid, failed pydantic validation

• event_params_invalid - The event_params failed validation against the jsonschema defined for the type/version. See response description for more details.

• event_unsupported - Event name is not known

• events_all_failed - All of events from the request failed to process, and uploaded to deadletter blob storage

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "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.

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...