logoLFG Heroes

GroupSessionCreated
v1.0.0

A signal that a user has created a new call for help

This event is created when a user has successfully requested aid in a game, effectively establishing a new LFG session.

flowchart LR l-Group_Session_Aggregate[Group Session Aggregate]:::producer-->GroupSessionCreated[GroupSessionCreated]:::event classDef event stroke:#b15fbf,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; GroupSessionCreated[GroupSessionCreated]:::event-->r-Group_Session_Aggregate[Group Session Aggregate]:::consumer GroupSessionCreated[GroupSessionCreated]:::event-->r-Group_Session_Projector[Group Session Projector]:::consumer GroupSessionCreated[GroupSessionCreated]:::event-->r-Group_Session_Process_Manager[Group Session Process Manager]:::consumer click l-Group_Session_Aggregate href "/services/Group Session Aggregate" "Go to Group Session Aggregate" _self click r-Group_Session_Aggregate href "/services/Group Session Aggregate" "Go to Group Session Aggregate" _self click r-Group_Session_Projector href "/services/Group Session Projector" "Go to Group Session Projector" _self click r-Group_Session_Process_Manager href "/services/Group Session Process Manager" "Go to Group Session Process Manager" _self click GroupSessionCreated href "/events/GroupSessionCreated" "Go to GroupSessionCreated" _self

Schema

sessionId
string
required

Globally unique ID for the group session

gameId
string
required

Globally unique identifier for the game

playerId
string
required

Initiating player's unique ID

expires
integer
required

If this session has an expiration period, this field contains the number of hours the session stays open

region
string

A description of the region in which the player needs help, if applicable

server
string

A description of the server on which the player resides, if applicable

notes
string

Freeform text describing the nature of the help request

minPlayers
integer

Minimum number of players (excluding session owner) required for group

maxPlayers
integer
required

Maximum number of players that can answer this call

timestamp
string
required

RFC 3339 timestamp when call creation occurred

platform
string
required

Platform on which the player needs help

Allowed values:
xboxplaystationpcnintendo
Edit this pageLast updated on 2023/9/25