Events

Consumes Events Needed For Unibo Gamification Platform

Consume list of supported events.

POST /api/v1/events

Consumes Events Needed For Unibo Gamification Platform

curl --request POST \
  --url 'https://api.example.com/api/v1/events' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'

No Body

Successful Response

Authorizations

  • x-api-key string required header

    Specific for one Tenant.

Request Body

application/json
  • items[] anyOf required array
    + Show Child Attributes
    • anyOf options 6 variants anyOf

      One or more options can apply.

      + Show Child Attributes
      • option 1 object

        Bets and Wins sent as a separate event for each

        + Show Child Attributes
        • data object required

          Game Round Event Data

          + Show Child Attributes
          • unique_id string required

            Unique message ID used for idempotency. Prevents sending the same event multiple times. Mostly useful when saving some of the events from list fails, allows you to easily retry with the same batch and will not cause any duplication issues.

          • timestamp string (date-time) required

            Event timestamp in UTC

          • player_id string required
          • game_id string required
          • round_id string required

            allows to connect Bets (is_win=False) with Wins (is_win=True)

          • amount number required

            Bet/Win amount in a positive float format

          • currency string required

            ISO-4217 currency code

          • is_win boolean required

            Indicates if this is a WIN (True) or BET (False) event

          • is_bonus boolean required

            Indicates if this bet/win used real money (False) or bonus one (True)

        • event string enum required enum

          Allowed values: gameround.

      • option 2 object

        Sent after a successful deposit

        + Show Child Attributes
        • data object required

          Deposit Event Data

          + Show Child Attributes
          • unique_id string required

            Unique message ID used for idempotency. Prevents sending the same event multiple times. Mostly useful when saving some of the events from list fails, allows you to easily retry with the same batch and will not cause any duplication issues.

          • timestamp string (date-time) required

            Event timestamp in UTC

          • player_id string required
          • amount number required
          • amount_eur number | null

            Deposit amount in EUR

          • currency string required

            ISO-4217 currency code

          • method string required

            Name of deposit method

        • event string enum required enum

          Allowed values: deposit.

      • option 3 object

        Sent after a successful withdraw

        + Show Child Attributes
        • data object required

          Withdraw Event Data

          + Show Child Attributes
          • unique_id string required

            Unique message ID used for idempotency. Prevents sending the same event multiple times. Mostly useful when saving some of the events from list fails, allows you to easily retry with the same batch and will not cause any duplication issues.

          • timestamp string (date-time) required

            Event timestamp in UTC

          • player_id string required
          • amount number required
          • currency string required

            ISO-4217 currency code

          • method string required

            Name of withdraw method

        • event string enum required enum

          Allowed values: withdraw.

      • option 4 object

        Sent when player registers or an update to any of his fields is made

        + Show Child Attributes
        • data object required

          Player account update

          + Show Child Attributes
          • unique_id string required

            Unique message ID used for idempotency. Prevents sending the same event multiple times. Mostly useful when saving some of the events from list fails, allows you to easily retry with the same batch and will not cause any duplication issues.

          • timestamp string (date-time) required

            Event timestamp in UTC

          • player_id string required
          • username string | null

            Player username

          • registration_date string (date-time) | null
          • country string | null
          • currency string | null

            Main player currency

          • gender string | null

            Choices should be M, F or null

          • affiliate string | null
          • operator string | null

            Operator identifier (as provided by the Game Provider/Aggregator)

          • tags anyOf
            + Show Child Attributes
            • anyOf options 2 variants anyOf

              One or more options can apply.

              + Show Child Attributes
              • option 1 array
                + Show Child Attributes
                • items[] string array item
              • option 2 null
          • consent_email boolean | null
          • is_blocked boolean | null
        • event string enum required enum

          Allowed values: player.

      • option 5 object

        Sent when game registers or an update to any of its fields is made

        + Show Child Attributes
        • data object required

          Game update

          + Show Child Attributes
          • unique_id string required

            Unique message ID used for idempotency. Prevents sending the same event multiple times. Mostly useful when saving some of the events from list fails, allows you to easily retry with the same batch and will not cause any duplication issues.

          • timestamp string (date-time) required

            Event timestamp in UTC

          • game_id string required
          • name string | null
          • provider string | null
          • categories anyOf
            + Show Child Attributes
            • anyOf options 2 variants anyOf

              One or more options can apply.

              + Show Child Attributes
              • option 1 array
                + Show Child Attributes
                • items[] string array item
              • option 2 null
          • features anyOf
            + Show Child Attributes
            • anyOf options 2 variants anyOf

              One or more options can apply.

              + Show Child Attributes
              • option 1 array
                + Show Child Attributes
                • items[] string array item
              • option 2 null
          • themes anyOf
            + Show Child Attributes
            • anyOf options 2 variants anyOf

              One or more options can apply.

              + Show Child Attributes
              • option 1 array
                + Show Child Attributes
                • items[] string array item
              • option 2 null
          • device string | null

            Basically you can put whatever values you want here (if omitted we'll default to 'undefined'), they will be dynamically available in Game Selection filtering.

          • has_freespins string enum | null

            Choices are: yes, no, unknown.

        • event string enum required enum

          Allowed values: game.

      • option 6 object
        + Show Child Attributes
        • data object required

          Login Event Data

          + Show Child Attributes
          • unique_id string required

            Unique message ID used for idempotency. Prevents sending the same event multiple times. Mostly useful when saving some of the events from list fails, allows you to easily retry with the same batch and will not cause any duplication issues.

          • timestamp string (date-time) required

            Event timestamp in UTC

          • player_id string required
        • event string enum required enum

          Allowed values: login.

Response

No structured response fields available.