Skip to main content
Last updated on December 9, 2025

Session Notification Events 0.1.0 documentation

Published Messages (session)

The service publishes one of these messages below.

onPartyCreated

Contains fields from and the following payload.

Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

id

This is a free-form object.

version

This is a free-form object.

name

This is a free-form object.

namespace

This is a free-form object.

parentNamespace

This is a free-form object.

timestamp

This is a free-form object.

userId

This is a free-form object.

traceId

This is a free-form object.

sessionId

This is a free-form object.

spanContext

This is a free-form object.

Published Messages (sessionNotification)

The service publishes one of these messages below.

sessionNotification

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

Published Messages (sessionEvent)

The service publishes one of these messages below.

OnSessionEnded

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

Published Messages (mpv2SessionHistory)

The service publishes one of these messages below.

GameSessionEndedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionInvitedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionInvitedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionMembersChangedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionKickedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionCreatedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionUpdatedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionRejectedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionDSStatusChangedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionCodeChangedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionCodeRevokedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyCreatedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyUpdatedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyKickedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyLeaveEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyInvitedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyRejectedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyJoinedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyMembersChangedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricTotalActiveSessionEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricAcquiringDsWaitTimeEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricAcquiringDsEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricMatchLengthDurationEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

GameSessionBackfillUpdateEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MatchHistoryEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricCreatedMatchmakingTicketEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricMatchMatchmakingEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

MetricMatchMatchmakingTicketEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyDeletedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyDisconnectedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyInviteCancelled

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyLeaderChanged

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyLeftEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

PartyRejoinedEvent

Contains fields from event and the following payload.

Example value
{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-

Schemas

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
userIdstring-
traceIdstring-
sessionIdstring-
spanContextstring-

notificationPayload

NameTypeDescription
userIdsarray-
namespacestring-
topicNamestring-
messagestring-