Ingest a custom player event

Ingest a custom in-game player events to Forge. Use this endpoint for any event that does not fit the dedicated playtime, achievement, or login endpoints — e.g. item_purchased,level_completed, match_ended. Partner and game details are identified automatically using the API key used to invoke the API. The API supports batch inserts to reduce the number of calls made to the service.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Notes:

  1. To ingest batch records, ensure each record follows the required body structure defined below and that all records are wrapped in a single array.
  2. Each record must include the below user identifier:
{ 
    "account_type": "<platform>",
    "id": "<account_id>" 
}

Example Input

{
  "user": {
    "account_type": "steam",
    "id": "76561198087147950"
  },
  "event": "level_up",
  "metadata": {
    "level": 10
  }
}
Body Params

A single in-game event record.

user
object
required

Identity via a platform account (e.g. Steam, Discord, Xbox).

string
required

Event type name defined by the partner.
Use snake_case. Example — level_up, item_purchased, match_ended.

metadata
object

Arbitrary key-value context for the event. Values may be any
primitive type. Omit or pass null if no extra context is needed.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json