In-Game Integration

Introduction

This document outlines the different methods we utilize to collect, process, and store game event data.

While we support a range of ingestion methods, we strongly recommend using our SDKs for their efficiency and ease of integration. If there are compatibility issues with the SDKs (for example, a webapp with a Rust backend), the Event API can be hit directly. In rare cases that can't be solved by either of the above options, we can consume events from a Kafka stream.

Data Ingestion Methods

1. Helika SDK

• Description: Clients install the correct SDK for their application, and use inbuilt event functions within.
• Format: Events are sent as an array, meaning any number of events can be transmitted at once.
• Recommendation: This is our preferred method of data ingestion and is highly recommended for clients.
• Getting started
  • Web SDK
  • Unity SDK
  • Unreal SDK

2. Helika Events API

• Description: Clients use our API endpoint to send their event data.
• Format: Events are sent as an array, meaning any number of events can be transmitted at once.
• Recommendation: This method can cover applications that aren't compatible with the SDKs.
• Getting started
  • Game Event API docs

3. Client’s Kafka Streams

• Description: We have Python consumer scripts that consume events from client’s Kafka streams.
• Process Flow:
  • The Python script consumes data from Kafka.
  • Data is dumped into our internal streams that aggregate with all event sources.
• Required Information from Customers:
  • Kafka bootstrap servers.
  • Topic names.
  • Consumer group details (if any).
  • Security protocols and credentials.
  • Data schema and format specifications.
• Getting started
  • Please contact your customer success manager for support.