EVENT GUIDE

wechess-gameplay-service

Service for managing real-time chess games, matchmaking, move history, and private invitations, including lifecycle management (mutual game-save/resume, admin termination), supporting both guest and registered users. Enables API access for reviewing games, enforcing moderation actions, and tracking game results.

Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email:

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

Documentation Scope

Welcome to the official documentation for the Gameplay Service Event descriptions. This guide is dedicated to detailing how to subscribe to and listen for state changes within the Gameplay Service, offering an exclusive focus on event subscription mechanisms.

Intended Audience

This documentation is aimed at developers and integrators looking to monitor Gameplay Service state changes. It is especially relevant for those wishing to implement or enhance business logic based on interactions with Gameplay objects.

Overview

This section provides detailed instructions on monitoring service events, covering payload structures and demonstrating typical use cases through examples.

Authentication and Authorization

Access to the Gameplay service’s events is facilitated through the project’s Kafka server, which is not accessible to the public. Subscription to a Kafka topic requires being on the same network and possessing valid Kafka user credentials. This document presupposes that readers have existing access to the Kafka server.

Additionally, the service offers a public subscription option via REST for real-time data management in frontend applications, secured through REST API authentication and authorization mechanisms. To subscribe to service events via the REST API, please consult the Realtime REST API Guide.

Database Events

Database events are triggered at the database layer, automatically and atomically, in response to any modifications at the data level. These events serve to notify subscribers about the creation, update, or deletion of objects within the database, distinct from any overarching business logic.

Listening to database events is particularly beneficial for those focused on tracking changes at the database level. A typical use case for subscribing to database events is to replicate the data store of one service within another service’s scope, ensuring data consistency and syncronization across services.

For example, while a business operation such as “approve membership” might generate a high-level business event like membership-approved, the underlying database changes could involve multiple state updates to different entities. These might be published as separate events, such as dbevent-member-updated and dbevent-user-updated, reflecting the granular changes at the database level.

Such detailed eventing provides a robust foundation for building responsive, data-driven applications, enabling fine-grained observability and reaction to the dynamics of the data landscape. It also facilitates the architectural pattern of event sourcing, where state changes are captured as a sequence of events, allowing for high-fidelity data replication and history replay for analytical or auditing purposes.

DbEvent chessGame-created

Event topic: wechess-gameplay-service-dbevent-chessgame-created

This event is triggered upon the creation of a chessGame data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent chessGame-updated

Event topic: wechess-gameplay-service-dbevent-chessgame-updated

Activation of this event follows the update of a chessGame data object. The payload contains the updated information under the chessGame attribute, along with the original data prior to update, labeled as old_chessGame and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_chessGame:{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
chessGame:{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent chessGame-deleted

Event topic: wechess-gameplay-service-dbevent-chessgame-deleted

This event announces the deletion of a chessGame data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent chessGameMove-created

Event topic: wechess-gameplay-service-dbevent-chessgamemove-created

This event is triggered upon the creation of a chessGameMove data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent chessGameMove-updated

Event topic: wechess-gameplay-service-dbevent-chessgamemove-updated

Activation of this event follows the update of a chessGameMove data object. The payload contains the updated information under the chessGameMove attribute, along with the original data prior to update, labeled as old_chessGameMove and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_chessGameMove:{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
chessGameMove:{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent chessGameMove-deleted

Event topic: wechess-gameplay-service-dbevent-chessgamemove-deleted

This event announces the deletion of a chessGameMove data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent chessGameInvitation-created

Event topic: wechess-gameplay-service-dbevent-chessgameinvitation-created

This event is triggered upon the creation of a chessGameInvitation data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent chessGameInvitation-updated

Event topic: wechess-gameplay-service-dbevent-chessgameinvitation-updated

Activation of this event follows the update of a chessGameInvitation data object. The payload contains the updated information under the chessGameInvitation attribute, along with the original data prior to update, labeled as old_chessGameInvitation and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_chessGameInvitation:{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
chessGameInvitation:{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent chessGameInvitation-deleted

Event topic: wechess-gameplay-service-dbevent-chessgameinvitation-deleted

This event announces the deletion of a chessGameInvitation data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent customBoard-created

Event topic: wechess-gameplay-service-dbevent-customboard-created

This event is triggered upon the creation of a customBoard data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent customBoard-updated

Event topic: wechess-gameplay-service-dbevent-customboard-updated

Activation of this event follows the update of a customBoard data object. The payload contains the updated information under the customBoard attribute, along with the original data prior to update, labeled as old_customBoard and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_customBoard:{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
customBoard:{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent customBoard-deleted

Event topic: wechess-gameplay-service-dbevent-customboard-deleted

This event announces the deletion of a customBoard data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent boardTheme-created

Event topic: wechess-gameplay-service-dbevent-boardtheme-created

This event is triggered upon the creation of a boardTheme data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent boardTheme-updated

Event topic: wechess-gameplay-service-dbevent-boardtheme-updated

Activation of this event follows the update of a boardTheme data object. The payload contains the updated information under the boardTheme attribute, along with the original data prior to update, labeled as old_boardTheme and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_boardTheme:{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
boardTheme:{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent boardTheme-deleted

Event topic: wechess-gameplay-service-dbevent-boardtheme-deleted

This event announces the deletion of a boardTheme data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent userPreference-created

Event topic: wechess-gameplay-service-dbevent-userpreference-created

This event is triggered upon the creation of a userPreference data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent userPreference-updated

Event topic: wechess-gameplay-service-dbevent-userpreference-updated

Activation of this event follows the update of a userPreference data object. The payload contains the updated information under the userPreference attribute, along with the original data prior to update, labeled as old_userPreference and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_userPreference:{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
userPreference:{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent userPreference-deleted

Event topic: wechess-gameplay-service-dbevent-userpreference-deleted

This event announces the deletion of a userPreference data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent gameHubMessage-created

Event topic: wechess-gameplay-service-dbevent-gamehubmessage-created

This event is triggered upon the creation of a gameHubMessage data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent gameHubMessage-updated

Event topic: wechess-gameplay-service-dbevent-gamehubmessage-updated

Activation of this event follows the update of a gameHubMessage data object. The payload contains the updated information under the gameHubMessage attribute, along with the original data prior to update, labeled as old_gameHubMessage and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_gameHubMessage:{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
gameHubMessage:{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent gameHubMessage-deleted

Event topic: wechess-gameplay-service-dbevent-gamehubmessage-deleted

This event announces the deletion of a gameHubMessage data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent gameHubModeration-created

Event topic: wechess-gameplay-service-dbevent-gamehubmoderation-created

This event is triggered upon the creation of a gameHubModeration data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent gameHubModeration-updated

Event topic: wechess-gameplay-service-dbevent-gamehubmoderation-updated

Activation of this event follows the update of a gameHubModeration data object. The payload contains the updated information under the gameHubModeration attribute, along with the original data prior to update, labeled as old_gameHubModeration and also you can find the old and new versions of updated-only portion of the data…

Event payload:

{
old_gameHubModeration:{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
gameHubModeration:{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent gameHubModeration-deleted

Event topic: wechess-gameplay-service-dbevent-gamehubmoderation-deleted

This event announces the deletion of a gameHubModeration data object, covering both hard deletions (permanent removal) and soft deletions (where the isActive attribute is set to false). Regardless of the deletion type, the event payload will present the data as it was immediately before deletion, highlighting an isActive status of false for soft deletions.

Event payload:

{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","isActive":false}

ElasticSearch Index Events

Within the Gameplay service, most data objects are mirrored in ElasticSearch indices, ensuring these indices remain syncronized with their database counterparts through creation, updates, and deletions. These indices serve dual purposes: they act as a data source for external services and furnish aggregated data tailored to enhance frontend user experiences. Consequently, an ElasticSearch index might encapsulate data in its original form or aggregate additional information from other data objects.

These aggregations can include both one-to-one and one-to-many relationships not only with database objects within the same service but also across different services. This capability allows developers to access comprehensive, aggregated data efficiently. By subscribing to ElasticSearch index events, developers are notified when an index is updated and can directly obtain the aggregated entity within the event payload, bypassing the need for separate ElasticSearch queries.

It’s noteworthy that some services may augment another service’s index by appending to the entity’s extends object. In such scenarios, an *-extended event will contain only the newly added data. Should you require the complete dataset, you would need to retrieve the full ElasticSearch index entity using the provided ID.

This approach to indexing and event handling facilitates a modular, interconnected architecture where services can seamlessly integrate and react to changes, enriching the overall data ecosystem and enabling more dynamic, responsive applications.

Index Event chessgame-created

Event topic: elastic-index-wechess_chessgame-created

Event payload:

{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgame-updated

Event topic: elastic-index-wechess_chessgame-created

Event payload:

{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgame-deleted

Event topic: elastic-index-wechess_chessgame-deleted

Event payload:

{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgame-extended

Event topic: elastic-index-wechess_chessgame-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event chessgamemove-created

Event topic: elastic-index-wechess_chessgamemove-created

Event payload:

{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgamemove-updated

Event topic: elastic-index-wechess_chessgamemove-created

Event payload:

{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgamemove-deleted

Event topic: elastic-index-wechess_chessgamemove-deleted

Event payload:

{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgamemove-extended

Event topic: elastic-index-wechess_chessgamemove-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event chessgameinvitation-created

Event topic: elastic-index-wechess_chessgameinvitation-created

Event payload:

{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgameinvitation-updated

Event topic: elastic-index-wechess_chessgameinvitation-created

Event payload:

{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgameinvitation-deleted

Event topic: elastic-index-wechess_chessgameinvitation-deleted

Event payload:

{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event chessgameinvitation-extended

Event topic: elastic-index-wechess_chessgameinvitation-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event customboard-created

Event topic: elastic-index-wechess_customboard-created

Event payload:

{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event customboard-updated

Event topic: elastic-index-wechess_customboard-created

Event payload:

{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event customboard-deleted

Event topic: elastic-index-wechess_customboard-deleted

Event payload:

{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event customboard-extended

Event topic: elastic-index-wechess_customboard-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event boardtheme-created

Event topic: elastic-index-wechess_boardtheme-created

Event payload:

{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event boardtheme-updated

Event topic: elastic-index-wechess_boardtheme-created

Event payload:

{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event boardtheme-deleted

Event topic: elastic-index-wechess_boardtheme-deleted

Event payload:

{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event boardtheme-extended

Event topic: elastic-index-wechess_boardtheme-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event userpreference-created

Event topic: elastic-index-wechess_userpreference-created

Event payload:

{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event userpreference-updated

Event topic: elastic-index-wechess_userpreference-created

Event payload:

{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event userpreference-deleted

Event topic: elastic-index-wechess_userpreference-deleted

Event payload:

{"id":"ID","userId":"ID","activeThemeId":"String","soundEnabled":"Boolean","showAnimations":"Boolean","boardOrientation":"Enum","boardOrientation_idx":"Integer","premoveEnabled":"Boolean","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event userpreference-extended

Event topic: elastic-index-wechess_userpreference-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event gamehubmessage-created

Event topic: elastic-index-wechess_gamehubmessage-created

Event payload:

{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event gamehubmessage-updated

Event topic: elastic-index-wechess_gamehubmessage-created

Event payload:

{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event gamehubmessage-deleted

Event topic: elastic-index-wechess_gamehubmessage-deleted

Event payload:

{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event gamehubmessage-extended

Event topic: elastic-index-wechess_gamehubmessage-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Index Event gamehubmoderation-created

Event topic: elastic-index-wechess_gamehubmoderation-created

Event payload:

{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event gamehubmoderation-updated

Event topic: elastic-index-wechess_gamehubmoderation-created

Event payload:

{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event gamehubmoderation-deleted

Event topic: elastic-index-wechess_gamehubmoderation-deleted

Event payload:

{"id":"ID","roomId":"ID","userId":"ID","action":"Enum","action_idx":"Integer","reason":"Text","duration":"Integer","expiresAt":null,"issuedBy":"ID","recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event gamehubmoderation-extended

Event topic: elastic-index-wechess_gamehubmoderation-extended

Event payload:

{
  id: id,
  extends: {
    [extendName]: "Object",
    [extendName + "_count"]: "Number",
  },
}

Route Events

Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route’s execution, is more pertinent.

Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity’s data but also route-specific metrics, such as the executing user’s permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.

The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service’s functional outcomes.

Route Event game-created

Event topic : wechess-gameplay-service-game-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-updated

Event topic : wechess-gameplay-service-game-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-deleted

Event topic : wechess-gameplay-service-game-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event game-retrived

Event topic : wechess-gameplay-service-game-retrived

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGame data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGame object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGame","method":"GET","action":"get","appVersion":"Version","rowCount":1,"chessGame":{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","moves":[{"moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date"},{},{}]}}

Route Event games-listed

Event topic : wechess-gameplay-service-games-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGames data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGames object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGames","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGames":[{"id":"ID","playerWhiteId":"ID","playerBlackId":"ID","createdById":"ID","status":"Enum","status_idx":"Integer","mode":"Enum","mode_idx":"Integer","invitationCode":"String","currentFEN":"String","gameType":"Enum","gameType_idx":"Integer","saveStatus":"Enum","saveStatus_idx":"Integer","saveRequestWhite":"Boolean","saveRequestBlack":"Boolean","movedAt":"Date","result":"Enum","result_idx":"Integer","terminatedById":"ID","reportStatus":"Enum","reportStatus_idx":"Integer","guestPlayerWhite":"Boolean","guestPlayerBlack":"Boolean","initialFEN":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gamemove-created

Event topic : wechess-gameplay-service-gamemove-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMove data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMove object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMove","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameMove":{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamemoves-listed

Event topic : wechess-gameplay-service-gamemoves-listed

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameMoves data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameMoves object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameMoves","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","chessGameMoves":[{"id":"ID","gameId":"ID","moveNumber":"Integer","moveNotation":"String","moveTime":"Integer","movedById":"ID","moveTimestamp":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event gameinvitation-created

Event topic : wechess-gameplay-service-gameinvitation-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"POST","action":"create","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-updated

Event topic : wechess-gameplay-service-gameinvitation-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gameinvitation-deleted

Event topic : wechess-gameplay-service-gameinvitation-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the chessGameInvitation data object itself.

The following JSON included in the payload illustrates the fullest representation of the chessGameInvitation object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"chessGameInvitation","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"chessGameInvitation":{"id":"ID","gameId":"ID","senderId":"ID","recipientId":"ID","status":"Enum","status_idx":"Integer","expiresAt":"Date","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-created

Event topic : wechess-gameplay-service-customboard-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"POST","action":"create","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-updated

Event topic : wechess-gameplay-service-customboard-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event customboard-deleted

Event topic : wechess-gameplay-service-customboard-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the customBoard data object itself.

The following JSON included in the payload illustrates the fullest representation of the customBoard object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"customBoard","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"customBoard":{"id":"ID","name":"String","fen":"String","description":"Text","isPublished":"Boolean","category":"Enum","category_idx":"Integer","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-created

Event topic : wechess-gameplay-service-boardtheme-created

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"POST","action":"create","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-updated

Event topic : wechess-gameplay-service-boardtheme-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event boardtheme-deleted

Event topic : wechess-gameplay-service-boardtheme-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the boardTheme data object itself.

The following JSON included in the payload illustrates the fullest representation of the boardTheme object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"boardTheme","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"boardTheme":{"id":"ID","name":"String","lightSquare":"String","darkSquare":"String","isPublished":"Boolean","createdById":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-deleted

Event topic : wechess-gameplay-service-gamehubmessage-deleted

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event gamehubmessage-updated

Event topic : wechess-gameplay-service-gamehubmessage-updated

Event payload:

The event payload, mirroring the REST API response, is structured as an encapsulated JSON. It includes metadata related to the API as well as the gameHubMessage data object itself.

The following JSON included in the payload illustrates the fullest representation of the gameHubMessage object. Note, however, that certain properties might be excluded in accordance with the object’s inherent logic.

{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"gameHubMessage","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"gameHubMessage":{"id":"ID","roomId":"ID","senderId":"ID","senderName":"String","senderAvatar":"String","messageType":"Enum","messageType_idx":"Integer","content":"Object","timestamp":null,"status":"Enum","status_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Copyright

All sources, documents and other digital materials are copyright of .

About Us

For more information please visit our website: .

. .