Responses

Players

Identification successful

If the player is successfully identified, this response will be sent.

{
  "res": "v1.players.identify.success",
  "data": PlayerAlias
}

Authentication required	Scopes
Yes	None

Channels

Receiving a message

If a player is subscribed to a channel where a message has been sent, they will receive this response.

{
  "res": "v1.channels.message",
  "data": {
    "channel": GameChannel
    "message": string,
    "playerAlias": PlayerAlias
  }
}

Authentication required	Scopes
Yes	read:gameChannels

Joining a channel

When a player joins a channel, all channel members will be notified.

{
  "res": "v1.channels.player-joined",
  "data": {
    "channel": GameChannel
    "playerAlias": PlayerAlias
  }
}

Authentication required	Scopes
Yes	read:gameChannels

Leaving a channel

When a player leaves a channel, all channel members will be notified.

{
  "res": "v1.channels.player-left",
  "data": {
    "channel": GameChannel
    "playerAlias": PlayerAlias
  }
}

Authentication required	Scopes
Yes	read:gameChannels

Types

GameChannel

type GameChannel = {
  id: number
  name: string
  owner: PlayerAlias
  totalMessages: number
  memberCount: number
  props: Prop[]
  createdAt: Date
  updatedAt: Date
}

PlayerAlias

type PlayerAlias = {
  id: number
  service: string
  identifier: string
  player: Player
  lastSeenAt: Date
  createdAt: Date
  updatedAt: Date
}

Player

type Player = {
  id: number
  props: Prop[]
  devBuild: boolean
  lastSeenAt: Date
  createdAt: Date
  groups: {
    id: number
    name: string
  }[]
  auth?: {
    email: string
    verificationEnabled: boolean
    sessionCreatedAt: Date
  }
}

Prop

type Prop = {
  key: string
  value: string | null
}