Catena API Explorer
/
Events

catena-tools-core (v1)

How To Use The API Explorer

On the right hand side of this page, you will see a list of "Servers".

  • Mock server: This server will return mock responses to all requests. It is best used when evaluating the shape of the Catena API.
  • Localhost: This server will point at a locally running version of Catena. It is best used when you want to make real requests or to validate that Catena is properly running on your machine.
  • Custom Domain: This server will point at any domain you specify with the domain variable. It is best used when you have a version of Catena deployed to a live environment and you want to make real requests against it.

To configure which server is shown in example requests:

  1. Select the "Try it" button on any API operation within the API explorer

api operation

  1. Select your environment

select environment

  1. If you want to point the API explorer to an instance of Catena you have deployed, select "Custom Domain" and configure the domain environment variable.

custom domain

  1. You're all set! This setting will be cached across all API operations exposed in these docs.
Download OpenAPI description
catena-tools-core.json
catena-tools-core.yaml
Languages
Servers
Mock server
https://docs.catenatools.com/_mock/apis/catena-tools-core/
Localhost
http://localhost:5000/
Custom Domain
https://{domain}/

CatenaApiKeys

CatenaApiKeys

Operations

CatenaAccounts

CatenaAccounts

Operations

CatenaServerManager

The server manager service portion of the integrated broker. This is what game servers interact with to handle matches.

Operations

CatenaAuthentication

CatenaAuthentication

Operations

CatenaSessions

A service that can be used to probe the session store directly for development or diagnostics. Not intended for regular production use!

Operations

CatenaTitles

CatenaTitles

Operations

CatenaServerReleases

CatenaServerManagement

Operations

CatenaPlatformAuth

A service for managing Catena-authoritative functionality with regards to validation and authentication. Used by validators in the Authentication service that log the user into the Catena platform.

Operations

CatenaParties

CatenaParties

Operations

CatenaNodeInspection

A service that can be used inspect the Catena node.

Operations

CatenaNodeControl

A service that can be used control the Catena node.

Operations

CatenaMatchBroker

An integrated match broker service which sits between the matchmaker, clients, and game servers/hosting to coordinate capacity and notify clients when servers are ready to accept connections. This implementation integrates the broker and capacity/server manager roles.

Operations

CatenaFriends

CatenaFriends

Operations

Events

Events

Operations

SubscribeToEvents

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/events/subscribe

Responses

Success

Bodyapplication/json
eventobject(Catena.Events.Event)
Response
application/json
{
  "event": {
    "eventId": "string",
    "recipientId": "string",
    "anyEvent": { … },
    "partyUpdateEvent": { … },
    "matchmakingStatusUpdateEvent": { … },
    "emptyEvent": {},
    "authenticationEvent": { … },
    "newMatchEvent": { … },
    "announcementEvent": { … },
    "accountsEvent": { … },
    "friendsEvent": { … }
  }
}

catena.events.Events_SubscribeToEventsByTag

Request

Query
senderIdstring
eventTagsArray of strings
curl -i -X GET \
  'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/events/subscribe/tags?eventTags=string&senderId=string'

Responses

Success

Bodyapplication/json
eventobject(Catena.Events.Event)
eventTagsArray of strings
Response
application/json
{
  "event": {
    "eventId": "string",
    "recipientId": "string",
    "anyEvent": { … },
    "partyUpdateEvent": { … },
    "matchmakingStatusUpdateEvent": { … },
    "emptyEvent": {},
    "authenticationEvent": { … },
    "newMatchEvent": { … },
    "announcementEvent": { … },
    "accountsEvent": { … },
    "friendsEvent": { … }
  },
  "eventTags": [
    "string"
  ]
}

EmitUpdateEvent

Request

Bodyapplication/json
nestedEventobject(Catena.Events.Event)
recipientIdsArray of strings
eventTagsArray of strings
broadcastboolean

affects how an empty recipient list is treated when tags are present; required to broadcast

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/events/emit \
  -H 'Content-Type: application/json' \
  -d '{
    "nestedEvent": {
      "eventId": "string",
      "recipientId": "string",
      "anyEvent": {
        "@type": "string",
        "property1": null,
        "property2": null
      },
      "partyUpdateEvent": {
        "type": "PARTY_UPDATE_TYPE_UNSPECIFIED",
        "message": "string",
        "partyId": "string",
        "eventPayload": {
          "property1": {
            "boolValue": true,
            "metadataValue": {
              "key": "string",
              "value": {
                "stringPayload": "string",
                "intPayload": 0,
                "jsonPayload": "string"
              }
            },
            "stringValue": "string",
            "playerValue": {
              "playerId": "string",
              "displayName": "string",
              "isReady": true,
              "isLeader": true,
              "teamNumber": 0,
              "metadata": {
                "property1": {},
                "property2": {}
              }
            },
            "intValue": 0,
            "metadataMapValue": {
              "metadata": {
                "property1": {},
                "property2": {}
              }
            }
          },
          "property2": {
            "boolValue": true,
            "metadataValue": {
              "key": "string",
              "value": {
                "stringPayload": "string",
                "intPayload": 0,
                "jsonPayload": "string"
              }
            },
            "stringValue": "string",
            "playerValue": {
              "playerId": "string",
              "displayName": "string",
              "isReady": true,
              "isLeader": true,
              "teamNumber": 0,
              "metadata": {
                "property1": {},
                "property2": {}
              }
            },
            "intValue": 0,
            "metadataMapValue": {
              "metadata": {
                "property1": {},
                "property2": {}
              }
            }
          }
        }
      },
      "matchmakingStatusUpdateEvent": {
        "type": "MATCHMAKING_STATUS_UPDATE_TYPE_UNSPECIFIED",
        "message": "string",
        "ticketId": "string",
        "additionalEventData": "string"
      },
      "emptyEvent": {},
      "authenticationEvent": {
        "type": "LOGOUT",
        "catenaAccountId": "string",
        "platformAccountId": "string",
        "platform": "PLATFORM_UNSPECIFIED"
      },
      "newMatchEvent": {
        "match": {
          "matchId": "string",
          "playerIds": [
            "string"
          ],
          "matchProperties": "string",
          "playerProperties": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "announcementEvent": {
        "message": "string"
      },
      "accountsEvent": {
        "type": "CREATE_OR_GET_ACCOUNT",
        "accountId": "string",
        "isNewAccount": true,
        "newPlatformType": "PLATFORM_UNSPECIFIED",
        "platforms": [
          "PLATFORM_UNSPECIFIED"
        ]
      },
      "friendsEvent": {
        "type": "UNSPECIFIED",
        "senderAccountId": "string",
        "receiverAccountId": "string"
      }
    },
    "recipientIds": [
      "string"
    ],
    "eventTags": [
      "string"
    ],
    "broadcast": true
  }'

Responses

Success

Bodyapplication/json
broadcastSuccessboolean
Response
application/json
{
  "broadcastSuccess": true
}

catena.events.Events_AdminEmitUpdateEvent

Request

Bodyapplication/json
nestedEventobject(Catena.Events.Event)
recipientIdsArray of strings
eventTagsArray of strings
broadcastboolean

affects how an empty recipient list is treated when tags are present; required to broadcast

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/admin/events/emit \
  -H 'Content-Type: application/json' \
  -d '{
    "nestedEvent": {
      "eventId": "string",
      "recipientId": "string",
      "anyEvent": {
        "@type": "string",
        "property1": null,
        "property2": null
      },
      "partyUpdateEvent": {
        "type": "PARTY_UPDATE_TYPE_UNSPECIFIED",
        "message": "string",
        "partyId": "string",
        "eventPayload": {
          "property1": {
            "boolValue": true,
            "metadataValue": {
              "key": "string",
              "value": {
                "stringPayload": "string",
                "intPayload": 0,
                "jsonPayload": "string"
              }
            },
            "stringValue": "string",
            "playerValue": {
              "playerId": "string",
              "displayName": "string",
              "isReady": true,
              "isLeader": true,
              "teamNumber": 0,
              "metadata": {
                "property1": {},
                "property2": {}
              }
            },
            "intValue": 0,
            "metadataMapValue": {
              "metadata": {
                "property1": {},
                "property2": {}
              }
            }
          },
          "property2": {
            "boolValue": true,
            "metadataValue": {
              "key": "string",
              "value": {
                "stringPayload": "string",
                "intPayload": 0,
                "jsonPayload": "string"
              }
            },
            "stringValue": "string",
            "playerValue": {
              "playerId": "string",
              "displayName": "string",
              "isReady": true,
              "isLeader": true,
              "teamNumber": 0,
              "metadata": {
                "property1": {},
                "property2": {}
              }
            },
            "intValue": 0,
            "metadataMapValue": {
              "metadata": {
                "property1": {},
                "property2": {}
              }
            }
          }
        }
      },
      "matchmakingStatusUpdateEvent": {
        "type": "MATCHMAKING_STATUS_UPDATE_TYPE_UNSPECIFIED",
        "message": "string",
        "ticketId": "string",
        "additionalEventData": "string"
      },
      "emptyEvent": {},
      "authenticationEvent": {
        "type": "LOGOUT",
        "catenaAccountId": "string",
        "platformAccountId": "string",
        "platform": "PLATFORM_UNSPECIFIED"
      },
      "newMatchEvent": {
        "match": {
          "matchId": "string",
          "playerIds": [
            "string"
          ],
          "matchProperties": "string",
          "playerProperties": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "announcementEvent": {
        "message": "string"
      },
      "accountsEvent": {
        "type": "CREATE_OR_GET_ACCOUNT",
        "accountId": "string",
        "isNewAccount": true,
        "newPlatformType": "PLATFORM_UNSPECIFIED",
        "platforms": [
          "PLATFORM_UNSPECIFIED"
        ]
      },
      "friendsEvent": {
        "type": "UNSPECIFIED",
        "senderAccountId": "string",
        "receiverAccountId": "string"
      }
    },
    "recipientIds": [
      "string"
    ],
    "eventTags": [
      "string"
    ],
    "broadcast": true
  }'

Responses

Success

Bodyapplication/json
broadcastSuccessboolean
Response
application/json
{
  "broadcastSuccess": true
}

CatenaEntitlements

Operations

CatenaLeaderboards

Operations

CatenaMatchmaking

Operations

CatenaServerCatalog

Operations

CatenaSteamDiag

Operations
Catena Tools 2025