Matchmaking V2 Notification Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

Specification ID: http://matchmaking-v2-service
Protobuf File Spec: notification.proto

Operations
- PUB freeformUserNotificationRequest
- PUB mpv2SessionHistory

Operations

PUB `freeformUserNotificationRequest` Operation

Message `freeformUserNotification`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

PUB `mpv2SessionHistory` Operation

Accepts one of the following messages:

Message `MatchmakingEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `MatchmakingStartedEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `MatchmakingTicketExpiredEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `MatchmakingTicketCanceledEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `MatchmakingTicketRejectedEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `MatchmakingTicketFoundEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `MatchFoundEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `BackfillFoundEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `BackfillProposalSentEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `BackfillProposalAcceptedEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `BackfillProposalRejectedEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `BackfillProposalExpiredEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Message `BackfillTicketExpiredEvent`

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userIds	array<string>	-	-	-	-
payload.userIds (single item)	string	-	-	-	-
payload.namespace	string	-	-	-	-
payload.topicName	string	-	-	-	-
payload.message	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (`date-time`)	-
traceId	string	-	-	-	-
spanContext	string	-	-	-	-

{
  "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",
  "traceId": "string",
  "spanContext": "string"
}

Matchmaking V2 Notification Events 0.1.0 documentation

Table of Contents

Operations

PUB `freeformUserNotificationRequest` Operation

Message `freeformUserNotification`

Payload

PUB `mpv2SessionHistory` Operation

Message `MatchmakingEvent`

Payload

Message `MatchmakingStartedEvent`

Payload

Message `MatchmakingTicketExpiredEvent`

Payload

Message `MatchmakingTicketCanceledEvent`

Payload

Message `MatchmakingTicketRejectedEvent`

Payload

Message `MatchmakingTicketFoundEvent`

Payload

Message `MatchFoundEvent`

Payload

Message `BackfillFoundEvent`

Payload

Message `BackfillProposalSentEvent`

Payload

Message `BackfillProposalAcceptedEvent`

Payload

Message `BackfillProposalRejectedEvent`

Payload

Message `BackfillProposalExpiredEvent`

Payload

Message `BackfillTicketExpiredEvent`

Payload

On this page

Matchmaking V2 Notification Events 0.1.0 documentation

Table of Contents​

Operations​

PUB freeformUserNotificationRequest Operation​

Message freeformUserNotification​

Payload​

PUB mpv2SessionHistory Operation​

Message MatchmakingEvent​

Payload​

Message MatchmakingStartedEvent​

Payload​

Message MatchmakingTicketExpiredEvent​

Payload​

Message MatchmakingTicketCanceledEvent​

Payload​

Message MatchmakingTicketRejectedEvent​

Payload​

Message MatchmakingTicketFoundEvent​

Payload​

Message MatchFoundEvent​

Payload​

Message BackfillFoundEvent​

Payload​

Message BackfillProposalSentEvent​

Payload​

Message BackfillProposalAcceptedEvent​

Payload​

Message BackfillProposalRejectedEvent​

Payload​

Message BackfillProposalExpiredEvent​

Payload​

Message BackfillTicketExpiredEvent​

Payload​

On this page

Table of Contents

Operations

PUB `freeformUserNotificationRequest` Operation

Message `freeformUserNotification`

Payload

PUB `mpv2SessionHistory` Operation

Message `MatchmakingEvent`

Payload

Message `MatchmakingStartedEvent`

Payload

Message `MatchmakingTicketExpiredEvent`

Payload

Message `MatchmakingTicketCanceledEvent`

Payload

Message `MatchmakingTicketRejectedEvent`

Payload

Message `MatchmakingTicketFoundEvent`

Payload

Message `MatchFoundEvent`

Payload

Message `BackfillFoundEvent`

Payload

Message `BackfillProposalSentEvent`

Payload

Message `BackfillProposalAcceptedEvent`

Payload

Message `BackfillProposalRejectedEvent`

Payload

Message `BackfillProposalExpiredEvent`

Payload

Message `BackfillTicketExpiredEvent`

Payload