Sign in

Event Types

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!

achieve-score

Event Name achieve-score

Required Meta Data

score number

The score

Optional Meta Data

required_time number

The time required involed 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

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 Name build-road

Required Meta Data

amount number

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

player_character string

The name of the player character

Optional Meta Data

map_name string

The name of a map

realm string

The realm

required_time number

The time required involed 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

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 Name capture-flag

Required Meta Data

amount number

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

Optional Meta Data

map_name string

The name of a map

player_character string

The name of the player character

required_time number

The time required involed 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

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 Name catch-animal

Required Meta Data

amount number

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

animal_name string

The name of an animal

Optional Meta Data

required_time number

The time required involed 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

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 Name character-fly

Required Meta Data

distance number

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

The name of the player character

Optional Meta Data

realm string

The realm

required_time number

The time required involed 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

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 Name character-respawn

Required Meta Data

amount number

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

player_character string

The name of the player character

Optional Meta Data

realm string

The realm

required_time number

The time required involed 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

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 Name character-run

Required Meta Data

distance number

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

The name of the player character

Optional Meta Data

realm string

The realm

required_time number

The time required involed 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

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 Name character-spawned

Required Meta Data

Optional Meta Data

player_character string

The name of the player character

time_condition string

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": {
        "player_character": "string",
        "time_condition": "string"
    }
}

character-survive

Event Name character-survive

Required Meta Data

duration number

The duration in any unit you like

player_character string

The name of the player character

Optional Meta Data

realm string

The realm

required_time number

The time required involed 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

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 Name character-walk

Required Meta Data

distance number

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

The name of the player character

Optional Meta Data

realm string

The realm

required_time number

The time required involed 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

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 Name collect-item

Required Meta Data

amount number

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

item_type string

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"
    }
}

craft-item

Event Name craft-item

Required Meta Data

amount number

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

item_type string

The type of an item

Optional Meta Data

required_time number

The time required involed 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

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 Name deal-damage

Required Meta Data

damage_amount number

The amount of damage

Optional Meta Data

player_character string

The name of the player character

required_time number

The time required involed 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

The timing condition

weapon_used string

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 Name defeat-boss

Required Meta Data

Optional Meta Data

enemy_character string

The character type or name of an enemy

health number

The health

hit_type string

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

player_character string

The name of the player character

required_time number

The time required involed 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

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 Name destroy-item

Required Meta Data

amount number

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

item_id string

The id of an item

Optional Meta Data

required_time number

The time required involed 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

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 Name earn-experience

Required Meta Data

amount number

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

Optional Meta Data

required_time number

The time required involed 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

The timing condition

type string

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 Name earn-points

Required Meta Data

amount number

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

Optional Meta Data

required_time number

The time required involed 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

The timing condition

type string

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 Name event-completed

Required Meta Data

action_type string

The name of the action

amount number

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

Optional Meta Data

action_object string

The object that is the source of the action

action_subject string

The object that is the target of the action

required_time number

The time required involed 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

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 Name finish-building

Required Meta Data

building_id string

The id or name of a building

Optional Meta Data

building_level number

The level of the building

required_time number

The time required involed 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

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 Name finish-fight

Required Meta Data

Optional Meta Data

battle_status number

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

enemy_character string

The character type or name of an enemy

health number

The health

hit_type string

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

player_character string

The name of the player character

required_time number

The time required involed 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 Name finish-laps

Required Meta Data

lap_position number

The position in a lap

required_time number

The time required involed 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

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 Name finish-round

Required Meta Data

round_id number

The id of the round

Optional Meta Data

battle_status number

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

enemy_character string

The character type or name of an enemy

health number

The health

player_character string

The name of the player character

required_time number

The time required involed 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

The type of the round

time_condition string

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 Name finish-transport

Required Meta Data

transport_id string

The id of the transport

Optional Meta Data

distance number

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

The number of fuel consumed

required_time number

The time required involed 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

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 Name fire-rate

Required Meta Data

amount number

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

Optional Meta Data

required_time number

The time required involed 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

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 Name gain-resource

Required Meta Data

amount number

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

resource_name string

The name of the resource

Optional Meta Data

required_time number

The time required involed 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

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 Name heal-unit

Required Meta Data

amount number

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

unit_type string

The name/id of a unit type

Optional Meta Data

required_time number

The time required involed 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

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 Name hire-crew

Required Meta Data

amount number

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

crew_name string

The name of a crew

Optional Meta Data

required_time number

The time required involed 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

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 Name instant-death

Required Meta Data

amount number

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

character_name string

The name of a character

Optional Meta Data

required_time number

The time required involed 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

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 Name instant-kill

Required Meta Data

amount number

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

Optional Meta Data

character_name string

The name of a character

required_time number

The time required involed 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

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 Name kill-ammo

Required Meta Data

ammo_used number

Number of ammonition used

Optional Meta Data

enemy_type string

The type of an enemy

player_character string

The name of the player character

required_time number

The time required involed 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

The timing condition

weapon_used string

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 Name kill-enemy

Required Meta Data

amount number

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

Optional Meta Data

enemy_type string

The type of an enemy

kill_type string

The type of a kill

map_name string

The name of a map

player_character string

The name of the player character

realm string

The realm

required_time number

The time required involed 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

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 Name lap-position

Required Meta Data

lap_position number

The position in a lap

required_time number

The time required involed 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

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-finish

Event Name match-finish

Required Meta Data

Optional Meta Data

time_condition string

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"
    }
}

match-start

Event Name match-start

Required Meta Data

Optional Meta Data

time_condition string

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"
    }
}

obtain-item

Event Name obtain-item

Required Meta Data

item_id string

The id of an item

Optional Meta Data

armor number

The “health” state of the armor

health number

The health

required_time number

The time required involed 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

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 Name pass-level

Required Meta Data

level_id string

The id of the level

Optional Meta Data

armor number

The “health” state of the armor

health number

The health

required_time number

The time required involed 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

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 Name pass-mission

Required Meta Data

mission_id string

The mission id

Optional Meta Data

armor number

The “health” state of the armor

health number

The health

required_time number

The time required involed 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

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 Name perform-jump

Required Meta Data

distance number

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

The health

required_time number

The time required involed 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

The score

time_condition string

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 Name play-card

Required Meta Data

amount number

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

card_type string

The name of the card

Optional Meta Data

required_time number

The time required involed 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

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 Name play-effect

Required Meta Data

amount number

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

effect_id string

The effect id or name

Optional Meta Data

required_time number

The time required involed 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

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 Name race-position

Required Meta Data

lap_position number

The position in a lap

Optional Meta Data

health number

The health

required_time number

The time required involed 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

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 Name reach-checkpoint

Required Meta Data

checkpoint_id string

The id/name of a checkpint

Optional Meta Data

armor number

The “health” state of the armor

health number

The health

required_time number

The time required involed 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

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 Name reach-coordinates

Required Meta Data

coordinate_x number

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

coordinate_y number

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

Optional Meta Data

required_time number

The time required involed 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

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 Name reach-distance

Required Meta Data

distance number

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

The health

required_time number

The time required involed 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

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 Name reach-height

Required Meta Data

distance number

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

The health

required_time number

The time required involed 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

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 Name reach-map-section

Required Meta Data

amount number

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

map_section_name string

The name of a section of a map

Optional Meta Data

required_time number

The time required involed 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

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 Name reach-progress

Required Meta Data

level_id string

The id of the level

Optional Meta Data

armor number

The “health” state of the armor

health number

The health

required_time number

The time required involed 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

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 Name reach-speed

Required Meta Data

amount number

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

Optional Meta Data

health number

The health

required_time number

The time required involed 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

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 Name receive-damage

Required Meta Data

damage_amount number

The amount of damage

Optional Meta Data

enemy_character string

The character type or name of an enemy

player_character string

The name of the player character

required_time number

The time required involed 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

The timing condition

weapon_used string

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 Name replenish-stat

Required Meta Data

amount number

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

Optional Meta Data

required_time number

The time required involed 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

The type of the stats item

time_condition string

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 Name secure-zone

Required Meta Data

amount number

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

Optional Meta Data

map_name string

The name of a map

required_time number

The time required involed 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

The timing condition

zone_name string

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 Name solve-puzzle

Required Meta Data

amount number

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

puzzle_id string

The id of a puzzle

Optional Meta Data

required_time number

The time required involed 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

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 Name spawn-item

Required Meta Data

amount number

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

item_type string

The type of an item

Optional Meta Data

required_time number

The time required involed 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 Name spray-graffiti

Required Meta Data

amount number

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

player_character string

The name of the player character

Optional Meta Data

map_name string

The name of a map

realm string

The realm

required_time number

The time required involed 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

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 Name trade-resource

Required Meta Data

amount_gained number

The number of ammonition gained

amount_given number

The number of amminition given

resource_gained number

The name/id of the resource gained

resource_given number

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

Optional Meta Data

required_time number

The time required involed 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

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": 0,
        "resource_given": 0,
        "required_time": 0,
        "time_condition": "string"
    }
}

trigger-event

Event Name trigger-event

Required Meta Data

amount number

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

Optional Meta Data

event_type string

The event type

player_character string

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 Name upgrade-item

Required Meta Data

amount number

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

Optional Meta Data

item_name string

The name of an item

required_time number

The time required involed 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

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 Name upgrade-weapon

Required Meta Data

amount number

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

weapon_id string

The id of the weapon

Optional Meta Data

player_character string

The name of the player character

required_time number

The time required involed 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

The timing condition

upgrade_type string

The name of the upgrade

weapon_used string

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 Name use-item

Required Meta Data

amount number

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

item_name string

The name of an item

Optional Meta Data

required_time number

The time required involed 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

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 Name user-invite

Required Meta Data

amount number

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 Name weapon-action

Required Meta Data

amount number

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

weapon_id string

The id of the weapon

weapon_used string

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

Optional Meta Data

player_character string

The name of the player character

required_time number

The time required involed 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

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 Name weapon-activated

Required Meta Data

Optional Meta Data

duration number

The duration in any unit you like

time_condition string

The timing condition

weapon_type string

The type of the weapon

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

win-bounty

Event Name win-bounty

Required Meta Data

amount number

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

bounty_name string

The name of the bounty

Optional Meta Data

required_time number

The time required involed 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

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 Name win-match

Required Meta Data

away_score number

The score of the opponent team

away_team_id string

The id of the opponent team

home_score number

The score of your or the home team

home_team_id string

The id or name of your or the home team

Optional Meta Data

required_time number

The time required involed 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

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 Name win-round

Required Meta Data

map_name string

The name of a map

round_id number

The id of the round

Optional Meta Data

player_character string

The name of the player character

required_time number

The time required involed 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

The type of the round

time_condition string

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"
    }
}