Predefined events

Last updated on October 24, 2024

Overview​

AGS Shared Cloud

Predefined Events are not available on AccelByte Gaming Services (AGS) Shared Cloud tier.

A predefined event is a type of telemetry that is designed to track function calls that map to APIs from AccelByte Gaming Services (AGS) through the Game SDK.

Developers have the option to opt for sending predefined events. The toggle options are as follows:

  • ON: All events listed below are sent.
  • OFF: No events listed below are sent. This is the default setting.

By default the toggle is OFF. Once you turn on predefined events, you can see how the SDK functions for every API call made to AGS, such as SDK initialization, login status, store status, matchmaking status, etc.

Note

This feature is still in development.

Turn On Pre Defined Events​

In the DefaultEngine.ini file, set SendPredefinedEvent under [/Script/AccelByteUe4Sdk.AccelByteSettings] to true. If you are using a Multi Environment setup, you can toggle this for each environment as seen below.

[/Script/AccelByteUe4Sdk.AccelByteSettings]
SendPredefinedEvent=true

[/Script/AccelByteUe4Sdk.AccelByteSettingsDev]
SendPredefinedEvent=true

[/Script/AccelByteUe4Sdk.AccelByteSettingsCert]
SendPredefinedEvent=true

[/Script/AccelByteUe4Sdk.AccelByteSettingsProd]
SendPredefinedEvent=true
...

For the Game Server, the following can be added similarly in the same .ini file

[/Script/AccelByteUe4Sdk.AccelByteServerSettings]
SendPredefinedEvent=true

[/Script/AccelByteUe4Sdk.AccelByteServerSettingsDev]
SendPredefinedEvent=true

[/Script/AccelByteUe4Sdk.AccelByteServerSettingsCert]
SendPredefinedEvent=true

[/Script/AccelByteUe4Sdk.AccelByteServerSettingsProd]
SendPredefinedEvent=true
...

View available predefined events​

Event categoryEvent nameEvent parameters
Core SDKSDK_Initialized
{
    "plugins":[
    {
      "name":<value>,
      "version":<value>
    },
  ...
  ]
}
AccessLogin_Succeeded
{
  "namespace":<value>,
  "userId":<value>,
  "platformId":<value>,
  "platformUserId":<value>,
  "deviceId":<value>
}
Login_Failed
{
  "namespace":<value>,
  "platformId":<value>
}
UserAgreement_Accepted
{
  "agreementDocuments":[
  {
    "localizedPolicyVersionId":<value>,
    "policyVersionId":<value>,
    "policyId":<value>
  },
  ...
  ]
}
UserAgreement_Rejected
{
  "agreementDocuments":[
    {
    "localizedPolicyVersionId":<value>,
    "policyVersionId":<value>,
    "policyId":<value>
    },
  ...
  ]
}
StorageUserProfile_Created
{
  "updatedFields":[
  <value>,
  ...
  ]
}
UserProfile_Updated
{
  "updatedFields":[
  <value>,
  ...
  ]
}
UserStatItem_Created
{
 "userId": <value>,
 "statCodes": [
  <value>,
  <value>
 ]
}
UserStatItem_Updated
{
 "userId": <value>,
 "statCodes": [
  <value>,
  <value>
 ]
}
UserStatItem_Deleted
{
 "userId": <value>,
 "statCodes": [
  <value>,
  <value>
 ]
}
PlayerRecord_Updated
{
  "key": <value>,
  "isPublic": <value>,
  "userId": <value>,
  "setBy": <value>,
  "strategy": <value>,
  "value": {<value>}
}
PlayerRecord_Deleted
{
  "userId": <value>,
  "key": <value>
}
GameRecord_Updated
{
  "key": <value>,
  "setBy": <value>,
  "strategy": <value>,
  "value": {<value>}
}
GameRecord_Deleted
{
"key":<value>
}
Monetization (Coming Soon)Store_Opened
{
  "storeId": <value>,
  "storeName": <value>,
  "category": <value>
}
Store_Closed
{
  "storeId": <value>,
  "storeName": <value>,
  "category": <value>
}
ItemInspect_Opened
{
  "itemId": <value>,
  "itemNamespace": <value>,
  "storeId": <value>,
  "language": <value>
}
ItemInspect_Closed
{
  "itemId": <value>,
  "itemNamespace": <value>,
  "storeId": <value>,
  "language": <value>
}
Currency_Updated
{
  "walletId": <value>,
  "currencyCode": <value>
}
Entitlement_Granted
{
  "entitlements": [
    {
      "itemId": <value>,
      "itemNamespace": <value>,
      "storeId": <value>,
      "grantedCode": <value>,
      "source": <value>
    },
    ...
  ]
}
CampaignCode_Redeemed
{
  "userID" : <string: value>,
  "code" : <string: value>,
  "entitlementSummaries": [
    {
      "id" : <string: value>,
      "name" : <string: value>,
      "type" : <string: value>,
      "clazz" : <string: value>,
      "itemId" : <string: value>,
      "storeId" : <string: value>,
    }
  ],
  "creditSummaries": [
    {
      "walletId" : <string: value>,
      "userId" : <string: value>,
      "amount" : <int: value>,
      "currencyCode" : <string: value> 
    }
  ],
  "subscriptionSummaries": [
    {
      "id" : <string: value>, 
      "userId" : <string: value>,
      "itemId" : <string: value>,
      "sku" : <string: value>,
      "status" : <string: value>,
      "subscribedBy" : <string: value>
    }
  ]
  
}
Item_Fulfilled
{
  "userID" : <string: value>,
  "entitlementSummaries": [
    {
      "id" : <string: value>,
      "name" : <string: value>,
      "type" : <string: value>,
      "clazz" : <string: value>,
      "itemId" : <string: value>,
      "storeId" : <string: value>,
    }
  ],
  "creditSummaries": [
    {
      "walletId" : <string: value>,
      "userId" : <string: value>,
      "amount" : <int: value>,
      "currencyCode" : <string: value>
    }
  ],
  "subscriptionSummaries": [
    {
      "id" : <string: value>,
      "userId" : <string: value>,
      "itemId" : <string: value>,
      "sku" : <string: value>,
      "status" : <string: value>,
      "subscribedBy" : <string: value>
    }
  ]
  
}
Item_Rewarded
{
   "success" : <value>
}
Payment_Succeeded
{
   "data" : [
      {
        "orderNo" : <string:value>
        "paymentOrderNo" : <string:value>
        "userId" : <string:value>
        "itemId" : <string:value>
        "price" : <int:value>
        "status" : <string:value> 
      }
    ]
}
Payment_Failed
{
   "data" : [
      {
        "orderNo" : <string:value>
        "paymentOrderNo" : <string:value>
        "userId" : <string:value>
        "itemId" : <string:value>
        "price" : <int:value>
        "status" : <string:value> 
      }
    ]
}
Wallet_Credited
{
   "userId" : <value>,
   "currencyCode" : <value>,
   "currencySymbol" : <value>,
   "balance" : <value>,
   "balanceOrigin" : <value>,
   "totalPermanentBalance" : <value>,
   "totalTimeLimitedBalance" : <value>,   
}
Wallet_Debited
{
   "userId" : <value>,
   "currencyCode" : <value>,
   "currencySymbol" : <value>,
   "balance" : <value>,
   "BalanceOrigin" : <value>,
   "totalPermanentBalance" : <value>,
   "totalTimeLimitedBalance" : <value>,   
}
Engagement (Coming Soon)Group_Created
{
  "configurationCode": <value>,
  "groupId": <value>,
  "groupMaxMember": <value>,
  "groupName": <value>,
  "groupRegion": <value>,
}
Group_Updated
{
  "configurationCode": <value>,
  "groupId": <value>,
  "groupMaxMember": <value>,
  "groupName": <value>,
  "groupRegion": <value>,
}
Group_Joined
{
  "groupId": <value>,
  "status": <value>,
  "userId": <value>
}
Group_Deleted
{
  "groupId": <value>,
  "namespace": <value>
}
Group_Left
{
  "groupId": <value>,
  "userId": <value>
}
GroupInvite_Accepted
{
  "groupId": <value>,
  "userId": <value>
}
GroupInvite_Rejected
{
  "groupId": <value>,
  "userId": <value>
}
GroupInvite_Cancelled
{
  "groupId": <value>,
  "userId": <value>
}
GroupJoinRequest_Accepted
{
  "groupId": <value>,
  "userId": <value>
}
GroupJoinRequest_Rejected
{
  "groupId": <value>,
  "userId": <value>
}
GroupMember_Kicked
{
  "groupId": <value>,
  "kickedUserId": <value>
}
GroupMember_RoleUpdated
{
  "groupId": <value>,
  "joinedAt": "2023-08-30T02:27:33.398Z",
  "memberRoleId": [
    <value>
  ],
  "status": <value>,
  "userId": <value>
}
Achievement_Unlocked
{
  "achievementCode": <value>
}
BattlePassMenu_ClaimReward
{
  "claimingRewards": {<value>}
}
BattlePassMenu_BulkClaimReward
{
  "claimingRewards": {<value>}
}
BattlePassMenu_GetCurrentSeason
{
  "id": <value>,
  "start": <value>,
  "end": <value>,
  "tierItemId": <value>,
  "status": <value>,
  "language": <value>,
}
BattlePassMenu_UserSpecificSeasonData
{
  "id": <value>,
  "userId": <value>,
  "seasonId": <value>,
  "currentTierIndex": <value>,
  "status": <value>,
  "cleared": <value>,
}
BattlePassMenu_UserCurrentSeasonData
{
  "id": <value>,
  "userId": <value>,
  "seasonId": <value>,
  "currentTierIndex": <value>,
  "status": <value>,
  "cleared": <value>,
}
UGCChannel_Created
{
  "id": <value>,
  "name": <value>,
  "namespace": <value>,
  "userId": <value>
}
UGCChannel_Updated
{
  "id": <value>,
  "name": <value>,
  "namespace": <value>,
  "userId": <value>
}
UGCChannel_Deleted
{
  "channelId": <value>,
  "userId": <value>
}
UGCContent_Added
{
  "channelId": <value>,
  "id": <value>,
  "isHidden": <value>,
  "isOfficial": <value>,
  "userId": <value>,
}
UGCContent_Updated
{
  "channelId": <value>,
  "id": <value>,
  "isHidden": <value>,
  "isOfficial": <value>,
  "userId": <value>,
}
UGCContent_Deleted
{
  "channelId": <value>,
  "contentId": <value>
}
UGCContent_Liked
{
  "contentId": <value>,
  "likeStatus": <value>
}
UGCContent_FollowCreator
{
  "followStatus": <value>,
  "userId": <value>
}
UGCContent_GetListFollowers
{
  "userId": <value>,
  "data": [
    {
      "followCount": <value>,
      "followingCount": <value>,
      "id": <value>,
      "namespace": <value>,
      "parentNamespace": <value>,
      "totalLikedContent": <value>
    }
  ]
}
UGCContent_GetUserContents
{
  "userId": <value>,
  "data": [
    {
      "followCount": <value>,
      "followingCount": <value>,
      "id": <value>,
      "namespace": <value>,
      "parentNamespace": <value>,
      "totalLikedContent": <value>
    }
  ]
}
UGCContent_UploadContentScreenshot
{
  "userId": <value>,
  "contentId": <value>,
  "screenshots": [
    {
      "contentType": <value>,
      "description": <value>,
      "fileExtension": <value>
    }
  ]
}
UGCContent_GetFollowedContent
{
  "data": [
    {
      "channelId": <value>,
      "id": <value>,
      "userId": <value>,
      "name": <value>,
      "namespace": <value>
    }
  ]
}
UGCContent_GetFollowedUsers
{
  "data": [
    {
      "followCount": <value>,
      "followingCount": <value>,
      "id": <value>,
      "namespace": <value>,
      "parentNamespace": <value>,
      "totalLikedContent": <value>
    }
  ]
}
UGCContent_GetLikedContents
{
  "data": [
    {
      "followCount": <value>,
      "followingCount": <value>,
      "id": <value>,
      "namespace": <value>,
      "parentNamespace": <value>,
      "totalLikedContent": <value>
    }
  ]
}
UGCContent_GetCreator
{
  "userId": <value>,
  "creatorFollowState": {
    "state": <value>,
    "userId": <value>
  },
  "followCount": <value>,
  "followingCount": <value>,
  "id": <value>,
  "namespace": <value>,
  "parentNamespace": <value>,
  "totalLikedContent": <value>
}
UGCContent_GetUserGroups
{
  "userId": <value>,
  "data": [
    {
      "contents": [
        <value>
      ],
      "createdAt": <value>,
      "id": <value>,
      "name": <value>,
      "namespace": <value>,
      "parentNamespace": <value>,
      "userId": <value>
    }
}
Play (Coming Soon)Lobby_Connected
{
  "userId": <value> 
}
Lobby_Disconnected
{
  "userId": <value>,
  "statusCode": <value> 
}
MPV1_GameSession_Created
{
  "userId": <value>,
  "gameSessionId": <value>
}
MPV1_GameSession_Joined
{
  "userId": <value>,
  "gameSessionId": <value>
}
MPV1_Matchmaking_Started
{
  "userId": <value>,
  "gameMode": <value>,
  "serverName": <value>,
  "clientVersion": <value>,
  "latencies": <value>,
  "partyAttribute": <value> 
}
MPV1_Matchmaking_MatchNotif_Received
{
  "userId": <value>,
  "matchId": <value>,
  "namespace": <value>,
  "matchPool": <value>,
  "teams": <value>,
  "tickets": <value>
}
MPV1_Matchmaking_ReadyConsent
{
  "userId": <value>,
  "matchId": <value> 
}
MPV1_Matchmaking_RejectMatch
{ 
  "userId": <value>, 
  "matchId": <value> 
}
MPV1_Matchmaking_Canceled
{ 
  "userId": <value>, 
  "gameMode": <value>, 
  "isTempParty": <value> 
}
MPV1_Party_Created
{
  "userId": <value>,
  "partyId": <value>
}
MPV1_Party_Invited
{
  "userId": <value>,
  "partyId": <value>
}
MPV1_Party_Joined
{
  "userId": <value>,
  "partyId": <value>
}
MPV1_Party_Left
{
  "userId": <value>,
  "partyId": <value>
}
MPV1_Party_Kicked
{
  "userId": <value>,
  "partyId": <value>
}
MPV2_GameSession_Created
{
  "userId": <value>,
  "gameSessionId": <value>
}
MPV2_GameSession_Invited
{
  "userId": <value>,
  "gameSessionId": <value>
}
MPV2_GameSession_Joined
{
  "userId": <value>,
  "gameSessionId": <value>
}
MPV2_GameSession_Left
{
  "userId": <value>,
  "gameSessionId": <value>
}
MPV2_GameSession_LeaderPromoted
{
  "promotedUserId": <value>,
  "gameSessionId": <value>
}
MPV2_PartySession_Created
{
  "userId": <value>,
  "partySessionId": <value>
}
MPV2_PartySession_Invited
{
  "userId": <value>,
  "partySessionId": <value>
}
MPV2_PartySession_Joined
{
  "userId": <value>,
  "partySessionId": <value>
}
MPV2_PartySession_Left
{
  "userId": <value>,
  "partySessionId": <value>
}
MPV2_PartySession_Kicked
{
  "userId": <value>,
  "partySessionId": <value>
}
MPV2_PartySession_LeaderPromoted
{
  "promotedUserId": <value>,
  "partySessionId": <value>
}
MPV2_Matchmaking_Requested
{
  "userId": <value>,
  "matchPool": <value>,
  "partySessionId": <value>,
  "attributes": <value>,
  "matchTicketId": <value>,
  "queueTime": <value>
}
MPV2_Matchmaking_Started
{
  "userId": <value>,
  "matchTicketId": <value>,
  "partySessionId": <value>,
  "matchPool": <value>
}
MPV2_Matchmaking_Canceled
{
  "userId": <value>
  "matchTicketId": <value>
}
FriendRequest_Sent
{
  "senderId": <value>,
  "receiverId": <value>
}
FriendRequest_Cancelled
{
  "senderId": <value>,
  "receiverId": <value>
}
FriendRequest_Accepted
{
  "senderId": <value>,
  "receiverId": <value>
}
FriendRequest_Rejected
{
  "senderId": <value>,
  "receiverId": <value>
}
Friend_Unfriended
{
  "userId": <value>,
  "friendId": <value>
}
User_Blocked
{
  "userId": <value>,
  "receiverId": <value>
}
User_Unblocked
{
  "userId": <value>,
  "receiverId": <value>
}
UserPresence_StatusUpdated
{ 
  "userId": <value>, 
  "status": <value> 
}
User_Banned
{
  "userId": <value>,
  "banType": <value>,
  "endDate": <value>,
  "reason": <value>
}
User_Unbanned
{
  "userId": <value>,
  "banType": <value>
}
ChatV2_Connected
{ 
  "userId": <value> 
}
ChatV2_Disconnected
{
  "userId": <value>,
  "statusCode": <value>
}
ChatV2_PersonalTopic_Created
{ 
  "userId": <value>, 
  "targetUserId": <value> 
}
ChatV2_GroupTopic_Created 
{
  "userId": <value>, 
  "name": <value>, 
  "members": <value>, 
  "admins": <value>, 
  "isJoinable": <value> 
}
ChatV2_Topic_Joined
{
  "userId": <value>,
  "topicId": <value>
}
ChatV2_Topic_Quit 
{
  "userId": <value>,
  "topicId": <value>
}
ChatV2_Topic_UserAdded
{
  "userId": <value>,
  "topicId": <value>
}
ChatV2_Topic_UserRemoved
{
  "userId": <value>,
  "topicId": <value>
}
ChatV2_Topic_Updated
{
  "userId": <value>,
  "name": <value>,
  "isJoinable": <value>
}
ChatV2_Topic_Deleted
{
  "userId": <value>,
  "topicId": <value>
}
ChatV2_UserBlocked
{ 
  "userId": <value>, 
  "blockedUserId": <value> 
}
ChatV2_UserUnblocked
{ 
  "userId": <value>, 
  "unblockedUserId": <value> 
}
ChatV2_GroupChat_ModeratorMutedUser
{
  "groupId": <value>,
  "moderatorId": <value>,
  "mutedUserId": <value>
}
ChatV2_GroupChat_ModeratorUnmutedUser
{
  "groupId": <value>,
  "moderatorId": <value>,
  "unmutedUserId": <value>
}
ChatV2_GroupChat_ModeratorBannedUser
{
  "groupId": <value>,
  "moderatorId": <value>,
  "bannedUserId": <value>
}
ChatV2_GroupChat_ModeratorUnbannedUser
{
  "groupId": <value>,
  "moderatorId": <value>,
  "unbannedUserId": <value>
}
ChatV2_GroupChat_ModeratorDeletedGroupChat
{ 
  "groupId": <value>, 
  "moderatorId": <value>, 
  "chatId": <value> 
}
AMS (Coming Soon)DS_DSHub_Connected
{ 
  "podName": <value>, 
}
DS_DSHub_Disconnected
{
  "podName": <value>,
  "statusCode": <value>
}
DS_Registered
{ 
  "podName": <value>, 
}
DS_Claimed
{
  "podName": <value>,
  "gameSessionId": <value>
}
DS_MemberChangedNotif_Received
{
  "podName": <value>,
  "gameSessionId": <value>,
  "members": <value>,
  "teams": <value>
}
DS_GameClient_Joined
{ 
  "podName": <value>, 
  "userId": <value> 
}
DS_GameClient_Left
{ 
  "podName": <value>, 
  "userId": <value> 
}
DS_BackfillProposal_Received
{
  "podName": <value>,
  "backfillTicketId": <value>,
  "proposalId": <value>,
  "matchPool": <value>,
  "gameSessionId": <value>,
  "proposedTeams": <value>,
  "addedTickets": <value>
}
DS_BackfillProposal_Accepted
{
  "podName": <value>,
  "backfillTicketId": <value>,
  "proposalId": <value>,
  "matchPool": <value>,
  "gameSessionId": <value>,
  "proposedTeams": <value>,
  "addedTickets": <value>
}
DS_BackfillProposal_Rejected
{
  "podName": <value>,
  "backfillTicketId": <value>,
  "proposalId": <value>,
  "matchPool": <value>,
  "gameSessionId": <value>,
  "proposedTeams": <value>,
  "addedTickets": <value>
}
DS_Unregistered
{ 
  "podName": <value>, 
}
Last updated on

On this page