Events & Payload in Webhooks

Flarie Studio allows you to trigger webhooks and CRM/ESP integrations based on a wide range of in-game events - giving you full control over when data is sent and exactly what’s included.

In this guide, you’ll get a detailed overview of all available events and their corresponding payload structures. 

You’ll also learn how to customize the payload format, map Flarie parameters to your system, and - if needed - batch data for specific events like Winners & Prizes (webhook only).

Events


Game - Triggers

  • First Game Start
    Description: Event sent the first time the Player starts the Game.

    Payload options: Event, Player, Game, Custom

  • Form Submission - StartGame
    Description: Event sent every time the form is submitted when the Player starts the Game. This event will be sent at the start of every Game Session.

    Payload options: Event, Player, Game, Custom

  • Game Start
    Description: Event sent every time the Player starts the Game.

    Payload options: Event, Player, Game, Custom

  • Challenge Completed
    Description: Event sent when the Player completes the challenge by reaching the set target in your Game, This event will only be sent once per Game Period.

    Payload options: Event, Player, Game, Game Score, Custom

  • Form Submission - Challenge Completed
    Description: Event sent when the Player submits the form after a Challenge has been completed. This event can be sent multiple times, since the Player can access the form and modify the details.

    Payload options: Event, Player, Game, Game Score, Custom

  • Game over
    Description: Event sent every time the Player completes a Game Round and submits a Game Score.

    Payload options: Event, Player, Game, Game Score, Custom

  • Winners & Prizes
    Description: Event sent with the generated winners when a Game or Game Period expires. Here you have the option to receive the winners by bulk or as single winner (one request sent per winner). 

    Payload options: Event, [Winners], Custom

  • Luck Winner Created
    Description: Event sent when the Player is defined as a winner in Luck Based Wins.

    Payload options: Event, Player, Game, Custom

 

Game Center - Triggers

  • Game Center SignUp
    Description: Event sent when the Player successfully registers in your Game Center.

    Payload options: Event, Player, Game Center, Custom

  • Game Center Additional Form Submission
    Description: Event sent when the Player submits the form of additional parameters in your Game Center. This popup will appear for the player if you add parameters to your Game Center and the Player has previously already registered.

    Payload options: Event, Player, Game Center, Custom

  • Game Center Rewards
    Description: Event sent when the Player purchase a Reward in the Game Center.

    Payload options: Event, Player, Game Center, Game Center Reward, Custom

 

Payload options - Flarie Values

  • Event
    Description: Data about the event itself. 

    Flarie Value JSON value Description
    eventId @event.eventId The id for the event
    eventName @event.eventName The name of the webhook 
    eventType @event.eventType The type of event, e.g. GAME_START
  • PlayerDescription: Data about the Player from your userbase. 

    Flarie Value JSON value Description
    playerId @userbase.playerId Default Flarie Parameter
    uuid @userbase.uuid Default Flarie Parameter
    username @userbase.username Default Flarie Parameter
    email @userbase.email Default Flarie Parameter
    firstName @userbase.firstName Default Flarie Parameter
    lastName @userbase.lastName Default Flarie Parameter
    fullName @userbase.fullName Default Flarie Parameter
    company @userbase.company Default Flarie Parameter
    phone @userbase.phone Default Flarie Parameter
    age @userbase.age Default Flarie Parameter
    gender @userbase.gender Default Flarie Parameter
    birthday @userbase.birthday Default Flarie Parameter
    address @userbase.address Default Flarie Parameter
    country @userbase.country Default Flarie Parameter
    city @userbase.city Default Flarie Parameter
    zipCode @userbase.zipCode Default Flarie Parameter
    src @userbase.src Deprecated. Will be removed soon.
    businessRegion @userbase.businessRegion Default Flarie Parameter
    consent @userbase.consent Default Flarie Parameter
    consentMandatory @userbase.consentMandatory Default Flarie Parameter
    param1 @userbase.param1 param1 is locked to Marketing Consent
    param2-10 @userbase.param2-10 Custom Parameter created in Assets & Settings
    terms1-5 @userbase.terms1-5 Deprecated. Will be removed soon.
    other1-5 @userbase.other-1-5 Deprecated. Will be removed soon.
  • Game
    Description: Data about the Game

    Flarie Value JSON value Description
    gameId @game.gameId The gameId
    gamePeriodId @game.gamePeriodId The gamePeriodId if split game is enabled
    game @game.game The name of the game in the library
    gameName @game.gameName The name you have given your game
  • Game Score 
    Description: Data about the Score of the current Game Round


    Flarie Value JSON value Description
    score @gameScore.score The score in the game round
    timeSpent @gameScore.timeSpent the amount of seconds played in the game round
  • Game Center 
    Description: Data about the Player from your userbase. 

    Flarie Value JSON value Description
    gameCenterId @gameCenter.gameCenterId The gameCenterId
    gameCenterName @gameCenterme.gameCenterName The name of your Game Center
  • Game Center Reward 
    Description: Data about the Player from your userbase. 

    Flarie Value JSON value Description
    gameCenterRewardId @gameCenterReward.gameCenterRewardId The Reward Id
    gameCenterRewardName @gameCenterReward.gameCenterRewardName The Reward name
    rewardPrice @gameCenterReward.rewardPrice The Rewards cost in coins
  • Winners 
    Description: Data about the Player from your userbase. 

    Flarie Value JSON value Description
    playerId @winner.playerId The playerId
    playerIdentifier @winner.playerIdentifier The Identifier option (playerId, email, phone or uuid)
    email @winner.email The email of the player
    username @winner.username the username of the player
    highscore @winner.highscore The players highscore in the game
    highscoreTime @winner.highscoreTime The amount of seconds played during the highscore
    ranking @winner.ranking The players ranking in the game

    Note! If you wish to use the Winners&Prizes event and receive all winners in one request, you may use Send in Bulk and Custom JSON Payload. The data needs to be formatted as an array as the example below. This will create an object of all winners within the array as the payload automatically. 
    events

  • Custom
    Description: Custom attributes for hard coded values

    Flarie Value JSON value Description
    Text Send custom text
    Number Send custom number
    Boolean - Send custom boolean