Events Reference

The core unit of SCILL is the event. An event is capturing a specific action for a user in time within your application. Events are the basic building blocks of features like challenges and battle passes. We created a couple of predefined events for a lot of different game and application types and that make it easy to integrate SCILL. You don’t need to think about data structures or mapping data to relational databases.

Just find the event that fits best in the list below and implement it in your application. If you are missing an event, please let us know!

Events in SCILL have this basic structure:

{
    "user_id": "[USER_ID]",
    "team_id": "[TEAM_ID]",
    "event_name": "[EVENT_NAME]",
    "event_type": "[EVENT_TYPE]",
    "session_id": "[SESSION_ID]",
    "meta_data": {
        "[PROPERTY_KEY_N]" : "[PROPERTY_VALUE_N]"
    }
}
Parameters

USER_ID string OPTIONAL

The user id is only required if events are sent via API Key, i.e. if you have initialized the EventsApi API instance with an API key. If you use the access token - which already encodes the user id, this field should not be used.

TEAM_ID string OPTIONAL

If you have a team based game or application, you can use this team_id to set the team of the user. As it’s a string, it’s up to you to set any value you like. This setting will be used in Leaderboards to generate team based rankings.

EVENT_NAME string REQUIRED

This is the name of the event. See Available Events for a list of possible values. Every event name has predefined required and optional properties as meta data that allow you to send additional, event specific information like the weapon_used or which time has been captured with time_condition.

EVENT_TYPE string REQUIRED

The event type defines how the event is processed together with other events of the same structure. Most SCILL features like Challenges and Leaderboards process multiple events of the same structure. How this processing is done in detail is defined by the event type. See Event Types in this page for more info on that.

SESSION_ID string REQUIRED

Sometimes, events of the same structure still should be subdivided into different sessions. Think of a sports match. It makes sense to group events of a specific sports match together, for example number of goals achieved. By setting a different Session ID for each match, you can create challenges like “Shoot 5 goals per match”. Set a persistent value if you don’t want to group events into sessions. The SDKs often expose an API to send events without a session id. In this case the default value used for the session id is persistent.

PROPERTY_KEY_N string

Depending on the event name different properties need to be set. For example often a property like amount has to be set. You can set any number of properties, but only those defined in the event structure are processed by the backend.

PROPERTY_VALUE_N int or string

Please make sure to send the property value in the correct form. We don’t support float values! If you want to send decimal values you have to convert them yourself to the next integer value that makes sense. For example in a racing game you typically store the lap time as number of seconds in a float value. Sending the event to SCILL is simple, just multiply your float value with 100 and round to the next integer.

Why no floats?

We don’t support floats for property values because challenges can be defined to only listen on specific combination of event structures. SCILL is a multi device and multi-platform service. And a JavaScript float is not always the same as the same value as a C# float, because there are different system to store floats in memory.

Most event property values like a lap time or a distance does not need the full float precision. Therefore, you scale the value to the precision you like and round it to an integer. This way, values can be compared in the backend.

Why this event structure?

When adding events to your code, you sometimes need to send two or even three events that could also be packed into one, why is that?

Flexibility is key in SCILL. We want to bring as much value as possible to you, which requires that it must be easy to integrate on your side, and it must be as structured as possible so that we can bring value the majority of our customers. If we would just offer a JSON payload, and you can send whatever you like, every developer using SCILL would send different data for the same things.

In this case, the SCILL developer team can not make any use of that data. By having structured events, we can add features to the platform, that make sense for a lot of developers and your life easier in the end.

Event Types

Event type defines how the event is processed in the SCILL Backend. Two possible values are possible today:

single
The amount value (can be a property like amount, score, distance, …) of the event is incremented to the last event with the same structure. Use that for events that will collect skill over time (i.e. the number of kills in a shooter for example)
group
The amount value overrides the last events value. Use this type for events that don’t collect skill over time, but where the current value defines the skill. A lap time in a racing game for example is typically not summed up over time.

Driving Progress

Required numerical fields, which are countable, like amount, score, distance drive the progress of our modules, like challenges and leaderboards. For leaderboards, these values are the primary ranking factors.

Events with no countable required parameters, like win-round, infer a value of 1, meaning a single round has been won.

Available Events

achieve-score

Event Nameachieve-score

Required Meta Data

score number REQUIRED

The score

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

achieve-score payload
{
    "user_id": "123",
    "event_name": "achieve-score",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "score": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

build-road

Event Namebuild-road

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

player_character string REQUIRED

The name of the player character

Optional Meta Data

map_name string OPTIONAL

The name of a map

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

build-road payload
{
    "user_id": "123",
    "event_name": "build-road",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "player_character": "string",
        "map_name": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

capture-flag

Event Namecapture-flag

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

map_name string OPTIONAL

The name of a map

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

capture-flag payload
{
    "user_id": "123",
    "event_name": "capture-flag",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "map_name": "string",
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

catch-animal

Event Namecatch-animal

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

animal_name string REQUIRED

The name of an animal

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

catch-animal payload
{
    "user_id": "123",
    "event_name": "catch-animal",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "animal_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

character-fly

Event Namecharacter-fly

Required Meta Data

distance number REQUIRED

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

player_character string REQUIRED

The name of the player character

Optional Meta Data

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

character-fly payload
{
    "user_id": "123",
    "event_name": "character-fly",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "distance": 0,
        "player_character": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

character-respawn

Event Namecharacter-respawn

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

player_character string REQUIRED

The name of the player character

Optional Meta Data

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

character-respawn payload
{
    "user_id": "123",
    "event_name": "character-respawn",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "player_character": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

character-run

Event Namecharacter-run

Required Meta Data

distance number REQUIRED

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

player_character string REQUIRED

The name of the player character

Optional Meta Data

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

character-run payload
{
    "user_id": "123",
    "event_name": "character-run",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "distance": 0,
        "player_character": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

character-spawned

Event Namecharacter-spawned

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

player_character string REQUIRED

The name of the player character

Optional Meta Data

time_condition string OPTIONAL

The timing condition

character-spawned payload
{
    "user_id": "123",
    "event_name": "character-spawned",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "player_character": "string",
        "time_condition": "string"
    }
}

character-survive

Event Namecharacter-survive

Required Meta Data

duration number REQUIRED

The duration in any unit you like

player_character string REQUIRED

The name of the player character

Optional Meta Data

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

character-survive payload
{
    "user_id": "123",
    "event_name": "character-survive",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "duration": 0,
        "player_character": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

character-walk

Event Namecharacter-walk

Required Meta Data

distance number REQUIRED

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

player_character string REQUIRED

The name of the player character

Optional Meta Data

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

character-walk payload
{
    "user_id": "123",
    "event_name": "character-walk",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "distance": 0,
        "player_character": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

collect-item

Event Namecollect-item

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

item_type string REQUIRED

The type of an item

Optional Meta Data

collect-item payload
{
    "user_id": "123",
    "event_name": "collect-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "item_type": "string"
    }
}

consume-content

Event Nameconsume-content

Required Meta Data

content_type string REQUIRED

Optional Meta Data

item_id string OPTIONAL

The id of an item

item_type string OPTIONAL

The type of an item

consume-content payload
{
    "user_id": "123",
    "event_name": "consume-content",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "content_type": "string",
        "item_id": "string",
        "item_type": "string"
    }
}

craft-item

Event Namecraft-item

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

item_type string REQUIRED

The type of an item

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

craft-item payload
{
    "user_id": "123",
    "event_name": "craft-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "item_type": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

deal-damage

Event Namedeal-damage

Required Meta Data

damage_amount number REQUIRED

The amount of damage

Optional Meta Data

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

weapon_used string OPTIONAL

The name/id of a weapon used in a kill or similar event

deal-damage payload
{
    "user_id": "123",
    "event_name": "deal-damage",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "damage_amount": 0,
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string",
        "weapon_used": "string"
    }
}

defeat-boss

Event Namedefeat-boss

Required Meta Data

Optional Meta Data

enemy_character string OPTIONAL

The character type or name of an enemy

health number OPTIONAL

The health

hit_type string OPTIONAL

The type of a hit (i.e. head, torso, leg)

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

defeat-boss payload
{
    "user_id": "123",
    "event_name": "defeat-boss",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "enemy_character": "string",
        "health": 0,
        "hit_type": "string",
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

destroy-item

Event Namedestroy-item

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

item_id string REQUIRED

The id of an item

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

destroy-item payload
{
    "user_id": "123",
    "event_name": "destroy-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "item_id": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

earn-experience

Event Nameearn-experience

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

type string OPTIONAL

The name/id of a type

earn-experience payload
{
    "user_id": "123",
    "event_name": "earn-experience",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "required_time": 0,
        "time_condition": "string",
        "type": "string"
    }
}

earn-points

Event Nameearn-points

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

type string OPTIONAL

The name/id of a type

earn-points payload
{
    "user_id": "123",
    "event_name": "earn-points",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "required_time": 0,
        "time_condition": "string",
        "type": "string"
    }
}

event-completed

Event Nameevent-completed

Required Meta Data

action_type string REQUIRED

The name of the action

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

action_object string OPTIONAL

The object that is the source of the action

action_subject string OPTIONAL

The object that is the target of the action

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

event-completed payload
{
    "user_id": "123",
    "event_name": "event-completed",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "action_type": "string",
        "amount": 0,
        "action_object": "string",
        "action_subject": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

finish-building

Event Namefinish-building

Required Meta Data

building_id string REQUIRED

The id or name of a building

Optional Meta Data

building_level number OPTIONAL

The level of the building

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

finish-building payload
{
    "user_id": "123",
    "event_name": "finish-building",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "building_id": "string",
        "building_level": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

finish-fight

Event Namefinish-fight

Required Meta Data

Optional Meta Data

battle_status number OPTIONAL

An integer value indicating the battle status (map it to an enum for example in your code)

enemy_character string OPTIONAL

The character type or name of an enemy

health number OPTIONAL

The health

hit_type string OPTIONAL

The type of a hit (i.e. head, torso, leg)

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

finish-fight payload
{
    "user_id": "123",
    "event_name": "finish-fight",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "battle_status": 0,
        "enemy_character": "string",
        "health": 0,
        "hit_type": "string",
        "player_character": "string",
        "required_time": 0
    }
}

finish-laps

Event Namefinish-laps

Required Meta Data

lap_position number REQUIRED

The position in a lap

required_time number REQUIRED

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

Optional Meta Data

time_condition string OPTIONAL

The timing condition

finish-laps payload
{
    "user_id": "123",
    "event_name": "finish-laps",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "lap_position": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

finish-round

Event Namefinish-round

Required Meta Data

round_id number REQUIRED

The id of the round

Optional Meta Data

battle_status number OPTIONAL

An integer value indicating the battle status (map it to an enum for example in your code)

enemy_character string OPTIONAL

The character type or name of an enemy

health number OPTIONAL

The health

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

round_type string OPTIONAL

The type of the round

time_condition string OPTIONAL

The timing condition

finish-round payload
{
    "user_id": "123",
    "event_name": "finish-round",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "round_id": 0,
        "battle_status": 0,
        "enemy_character": "string",
        "health": 0,
        "player_character": "string",
        "required_time": 0,
        "round_type": "string",
        "time_condition": "string"
    }
}

finish-transport

Event Namefinish-transport

Required Meta Data

transport_id string REQUIRED

The id of the transport

Optional Meta Data

distance number OPTIONAL

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

fuel_consumed number OPTIONAL

The number of fuel consumed

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

finish-transport payload
{
    "user_id": "123",
    "event_name": "finish-transport",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "transport_id": "string",
        "distance": 0,
        "fuel_consumed": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

fire-rate

Event Namefire-rate

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

fire-rate payload
{
    "user_id": "123",
    "event_name": "fire-rate",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

gain-resource

Event Namegain-resource

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

resource_name string REQUIRED

The name of the resource

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

gain-resource payload
{
    "user_id": "123",
    "event_name": "gain-resource",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "resource_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

heal-unit

Event Nameheal-unit

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

unit_type string REQUIRED

The name/id of a unit type

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

heal-unit payload
{
    "user_id": "123",
    "event_name": "heal-unit",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "unit_type": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

hire-crew

Event Namehire-crew

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

crew_name string REQUIRED

The name of a crew

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

hire-crew payload
{
    "user_id": "123",
    "event_name": "hire-crew",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "crew_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

instant-death

Event Nameinstant-death

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

character_name string REQUIRED

The name of a character

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

instant-death payload
{
    "user_id": "123",
    "event_name": "instant-death",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "character_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

instant-kill

Event Nameinstant-kill

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

character_name string OPTIONAL

The name of a character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

instant-kill payload
{
    "user_id": "123",
    "event_name": "instant-kill",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "character_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

kill-ammo

Event Namekill-ammo

Required Meta Data

ammo_used number REQUIRED

Number of ammonition used

Optional Meta Data

enemy_type string OPTIONAL

The type of an enemy

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

weapon_used string OPTIONAL

The name/id of a weapon used in a kill or similar event

kill-ammo payload
{
    "user_id": "123",
    "event_name": "kill-ammo",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "ammo_used": 0,
        "enemy_type": "string",
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string",
        "weapon_used": "string"
    }
}

kill-enemy

Event Namekill-enemy

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

enemy_type string OPTIONAL

The type of an enemy

kill_type string OPTIONAL

The type of a kill

map_name string OPTIONAL

The name of a map

player_character string OPTIONAL

The name of the player character

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

weapon_used string OPTIONAL

The name/id of a weapon used in a kill or similar event

kill-enemy payload
{
    "user_id": "123",
    "event_name": "kill-enemy",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "enemy_type": "string",
        "kill_type": "string",
        "map_name": "string",
        "player_character": "string",
        "realm": "string",
        "required_time": 0,
        "weapon_used": "string"
    }
}

lap-position

Event Namelap-position

Required Meta Data

lap_position number REQUIRED

The position in a lap

required_time number REQUIRED

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

Optional Meta Data

time_condition string OPTIONAL

The timing condition

lap-position payload
{
    "user_id": "123",
    "event_name": "lap-position",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "lap_position": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

match-start

Event Namematch-start

Required Meta Data

Optional Meta Data

time_condition string OPTIONAL

The timing condition

match-start payload
{
    "user_id": "123",
    "event_name": "match-start",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "time_condition": "string"
    }
}

match-finish

Event Namematch-finish

Required Meta Data

Optional Meta Data

time_condition string OPTIONAL

The timing condition

match-finish payload
{
    "user_id": "123",
    "event_name": "match-finish",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "time_condition": "string"
    }
}

obtain-item

Event Nameobtain-item

Required Meta Data

item_id string REQUIRED

The id of an item

Optional Meta Data

armor number OPTIONAL

The “health” state of the armor

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

obtain-item payload
{
    "user_id": "123",
    "event_name": "obtain-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "item_id": "string",
        "armor": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

pass-level

Event Namepass-level

Required Meta Data

level_id string REQUIRED

The id of the level

Optional Meta Data

armor number OPTIONAL

The “health” state of the armor

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

pass-level payload
{
    "user_id": "123",
    "event_name": "pass-level",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "level_id": "string",
        "armor": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

pass-mission

Event Namepass-mission

Required Meta Data

mission_id string REQUIRED

The mission id

Optional Meta Data

armor number OPTIONAL

The “health” state of the armor

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

pass-mission payload
{
    "user_id": "123",
    "event_name": "pass-mission",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "mission_id": "string",
        "armor": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

perform-jump

Event Nameperform-jump

Required Meta Data

distance number REQUIRED

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

Optional Meta Data

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

score number OPTIONAL

The score

time_condition string OPTIONAL

The timing condition

perform-jump payload
{
    "user_id": "123",
    "event_name": "perform-jump",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "distance": 0,
        "health": 0,
        "required_time": 0,
        "score": 0,
        "time_condition": "string"
    }
}

play-card

Event Nameplay-card

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

card_type string REQUIRED

The name of the card

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

play-card payload
{
    "user_id": "123",
    "event_name": "play-card",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "card_type": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

play-effect

Event Nameplay-effect

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

effect_id string REQUIRED

The effect id or name

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

play-effect payload
{
    "user_id": "123",
    "event_name": "play-effect",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "effect_id": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

race-position

Event Namerace-position

Required Meta Data

lap_position number REQUIRED

The position in a lap

Optional Meta Data

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

race-position payload
{
    "user_id": "123",
    "event_name": "race-position",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "lap_position": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-checkpoint

Event Namereach-checkpoint

Required Meta Data

checkpoint_id string REQUIRED

The id/name of a checkpint

Optional Meta Data

armor number OPTIONAL

The “health” state of the armor

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-checkpoint payload
{
    "user_id": "123",
    "event_name": "reach-checkpoint",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "checkpoint_id": "string",
        "armor": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-coordinates

Event Namereach-coordinates

Required Meta Data

coordinate_x number REQUIRED

The x coordinate in your coordinate system, used for example to store position on a map

coordinate_y number REQUIRED

The y coordinate in your coordinate system, used for example to store position on a map

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-coordinates payload
{
    "user_id": "123",
    "event_name": "reach-coordinates",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "coordinate_x": 0,
        "coordinate_y": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-distance

Event Namereach-distance

Required Meta Data

distance number REQUIRED

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

Optional Meta Data

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-distance payload
{
    "user_id": "123",
    "event_name": "reach-distance",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "distance": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-height

Event Namereach-height

Required Meta Data

distance number REQUIRED

The distance measured in any coordinate system of your choice. Please note: This is an integer field. If you need more precision multiple your floating point value with 1000 or so to keep the precision but storing it as an integer value

Optional Meta Data

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-height payload
{
    "user_id": "123",
    "event_name": "reach-height",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "distance": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-map-section

Event Namereach-map-section

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

map_section_name string REQUIRED

The name of a section of a map

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-map-section payload
{
    "user_id": "123",
    "event_name": "reach-map-section",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "map_section_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-progress

Event Namereach-progress

Required Meta Data

level_id string REQUIRED

The id of the level

Optional Meta Data

armor number OPTIONAL

The “health” state of the armor

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-progress payload
{
    "user_id": "123",
    "event_name": "reach-progress",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "level_id": "string",
        "armor": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

reach-speed

Event Namereach-speed

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

health number OPTIONAL

The health

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

reach-speed payload
{
    "user_id": "123",
    "event_name": "reach-speed",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "health": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

receive-damage

Event Namereceive-damage

Required Meta Data

damage_amount number REQUIRED

The amount of damage

Optional Meta Data

enemy_character string OPTIONAL

The character type or name of an enemy

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

weapon_used string OPTIONAL

The name/id of a weapon used in a kill or similar event

receive-damage payload
{
    "user_id": "123",
    "event_name": "receive-damage",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "damage_amount": 0,
        "enemy_character": "string",
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string",
        "weapon_used": "string"
    }
}

replenish-stat

Event Namereplenish-stat

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

stat_type string OPTIONAL

The type of the stats item

time_condition string OPTIONAL

The timing condition

replenish-stat payload
{
    "user_id": "123",
    "event_name": "replenish-stat",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "required_time": 0,
        "stat_type": "string",
        "time_condition": "string"
    }
}

secure-zone

Event Namesecure-zone

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

map_name string OPTIONAL

The name of a map

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

zone_name string OPTIONAL

The name of the zone

secure-zone payload
{
    "user_id": "123",
    "event_name": "secure-zone",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "map_name": "string",
        "required_time": 0,
        "time_condition": "string",
        "zone_name": "string"
    }
}

solve-puzzle

Event Namesolve-puzzle

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

puzzle_id string REQUIRED

The id of a puzzle

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

solve-puzzle payload
{
    "user_id": "123",
    "event_name": "solve-puzzle",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "puzzle_id": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

spawn-item

Event Namespawn-item

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

item_type string REQUIRED

The type of an item

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

spawn-item payload
{
    "user_id": "123",
    "event_name": "spawn-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "item_type": "string",
        "required_time": 0
    }
}

spray-graffiti

Event Namespray-graffiti

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

player_character string REQUIRED

The name of the player character

Optional Meta Data

map_name string OPTIONAL

The name of a map

realm string OPTIONAL

The realm

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

spray-graffiti payload
{
    "user_id": "123",
    "event_name": "spray-graffiti",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "player_character": "string",
        "map_name": "string",
        "realm": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

trade-resource

Event Nametrade-resource

Required Meta Data

amount_gained number REQUIRED

The number of ammonition gained

amount_given number REQUIRED

The number of amminition given

resource_gained string REQUIRED

The name/id of the resource gained

resource_given string REQUIRED

The name/id of the resource given (to someone else)

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

trade-resource payload
{
    "user_id": "123",
    "event_name": "trade-resource",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount_gained": 0,
        "amount_given": 0,
        "resource_gained": "string",
        "resource_given": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

trigger-event

Event Nametrigger-event

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

event_type string OPTIONAL

The event type

player_character string OPTIONAL

The name of the player character

trigger-event payload
{
    "user_id": "123",
    "event_name": "trigger-event",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "event_type": "string",
        "player_character": "string"
    }
}

upgrade-item

Event Nameupgrade-item

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

item_name string REQUIRED

The name of an item

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

upgrade-item payload
{
    "user_id": "123",
    "event_name": "upgrade-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "item_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

upgrade-weapon

Event Nameupgrade-weapon

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

weapon_id string REQUIRED

The id of the weapon

Optional Meta Data

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

upgrade_type string OPTIONAL

The name of the upgrade

weapon_used string OPTIONAL

The name/id of a weapon used in a kill or similar event

upgrade-weapon payload
{
    "user_id": "123",
    "event_name": "upgrade-weapon",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "weapon_id": "string",
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string",
        "upgrade_type": "string",
        "weapon_used": "string"
    }
}

use-item

Event Nameuse-item

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

item_name string REQUIRED

The name of an item

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

use-item payload
{
    "user_id": "123",
    "event_name": "use-item",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "item_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

user-invite

Event Nameuser-invite

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

Optional Meta Data

user-invite payload
{
    "user_id": "123",
    "event_name": "user-invite",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0
    }
}

weapon-action

Event Nameweapon-action

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

weapon_id string REQUIRED

The id of the weapon

weapon_used string REQUIRED

The name/id of a weapon used in a kill or similar event

Optional Meta Data

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

weapon-action payload
{
    "user_id": "123",
    "event_name": "weapon-action",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "weapon_id": "string",
        "weapon_used": "string",
        "player_character": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

weapon-activated

Event Nameweapon-activated

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

weapon_type string REQUIRED

The type of the weapon

Optional Meta Data

duration number OPTIONAL

The duration in any unit you like

time_condition string OPTIONAL

The timing condition

weapon-activated payload
{
    "user_id": "123",
    "event_name": "weapon-activated",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "weapon_type": "string",
        "duration": 0,
        "time_condition": "string"
    }
}

win-bounty

Event Namewin-bounty

Required Meta Data

amount number REQUIRED

A general indicator for number of items (i.e. number of kills in kill-enemy event)

bounty_name string REQUIRED

The name of the bounty

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

win-bounty payload
{
    "user_id": "123",
    "event_name": "win-bounty",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "amount": 0,
        "bounty_name": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

win-match

Event Namewin-match

Required Meta Data

away_score number REQUIRED

The score of the opponent team

away_team_id string REQUIRED

The id of the opponent team

home_score number REQUIRED

The score of your or the home team

home_team_id string REQUIRED

The id or name of your or the home team

Optional Meta Data

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

time_condition string OPTIONAL

The timing condition

win-match payload
{
    "user_id": "123",
    "event_name": "win-match",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "away_score": 0,
        "away_team_id": "string",
        "home_score": 0,
        "home_team_id": "string",
        "required_time": 0,
        "time_condition": "string"
    }
}

win-round

Event Namewin-round

Required Meta Data

map_name string REQUIRED

The name of a map

round_id number REQUIRED

The id of the round

Optional Meta Data

player_character string OPTIONAL

The name of the player character

required_time number OPTIONAL

The time required involved in this event, i.e. in a reach-checkpoint event this could be the time in seconds required to reach that checkpoint from the last checkpoint.

round_type string OPTIONAL

The type of the round

time_condition string OPTIONAL

The timing condition

win-round payload
{
    "user_id": "123",
    "event_name": "win-round",
    "event_type": "single",
    "session_id": "123e4567-e89b-12d3-a456-426652340001",
    "meta_data": {
        "map_name": "string",
        "round_id": 0,
        "player_character": "string",
        "required_time": 0,
        "round_type": "string",
        "time_condition": "string"
    }
}