Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Gameball (Actions) Destination


Destination Info
  • Accepts Page, Alias, Group, Identify and Track calls.
  • Refer to it as gameball, or Gameball (Actions) in the Integrations object
  • This integration is partner owned. Please reach out to the partner's support for any issues.
  • This destination is in Beta

Gameball(link takes you to an external page) is an all-in-one customer loyalty marketing platform that empowers brands to create personalized retention campaigns, helping them grow and monetize their customer base using cutting-edge gamification strategies. Using Gameball, you can increase customer lifetime value and secure unmatched conversion rates - capturing untapped opportunities.

This destination is maintained by Gameball. For any issues with the destination, contact the Gameball Support team..


Benefits of Gameball (Actions) vs Gameball Classic

benefits-of-gameball-actions-vs-gameball-classic page anchor

Gameball (Actions) provides the following benefits over the classic Gameball destination:

Fewer settings: Data mapping for actions-based destinations happens in during configuration, which eliminates the need for most settings. Clearer mapping of data: Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination. Support for Gameball V3 API: Gameball (Actions) is built on the latest version of Gameball APIs(link takes you to an external page).


  1. Go to your Gameball dashboard(link takes you to an external page). Click Settings in the bottom left, then click on Account Integration. Copy the API Key and Secret Key.
  2. From your Segment workspace's Destination catalog page(link takes you to an external page) search for Gameball.
  3. Select Gameball (Actions) and click Add Destination.
  4. Select an existing Source to connect to Gameball (Actions).
  5. Enter the API Key and Secret key in the destination settings in Segment.

Property nameTypeRequiredDescription
API Keypassword
required

Go to help center(link takes you to an external page) to learn how to find your API Key.


Secret Keypassword
required

Go to help center(link takes you to an external page) to learn how to find your API Key.


Gameball (Actions) has the following presets

Preset NameTriggerDefault Action
Track OrdersEvent type = "track" and event = "Order Completed"Track Order
Create Or Update PlayersEvent type = "identify"Identify Player
Track EventsEvent type = "track" and event != "Order Completed"Track Event

Build your own Mappings. Combine supported triggers with the following Gameball-supported actions:

(information)

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

Identify Player

identify-player page anchor

This Action used to create or update a player in Gameball with the provided attributes.

Identify Player is a Cloud action. The default Trigger is type = "identify"

Property nameTypeRequiredDescription
Player IDSTRING
required

Unique identifier for the player in your database.


Mobile NumberSTRING

Optional

Player's unique mobile number.


EmailSTRING

Optional

Player's unique email.


Display NameSTRING

Optional

Player's display name


First NameSTRING

Optional

Player's first name


Last NameSTRING

Optional

Player's last name


GenderSTRING

Optional

Player's gender.


Date Of BirthDATETIME

Optional

Player's date of birth


Join DateDATETIME

Optional

Player's join date at your system.


CountrySTRING

Optional

Player's country.


CitySTRING

Optional

Player's city


Zip codeSTRING

Optional

Player's zip code


Preferred languageSTRING

Optional

Player's preferred language


GuestBOOLEAN

Optional

A boolean value indicating if the customer who placed this order is a guest. The default is false.


UTMsOBJECT

Optional

Player's utms


DevicesOBJECT

Optional

Player's used devices


Total SpentNUMBER

Optional

Player's total spent amount


Last Order DateDATETIME

Optional

Player's last order date


Total OrdersNUMBER

Optional

Player's total orders


Average Order AmountNUMBER

Optional

Player's average order amount


TagsSTRING

Optional

Comma separated string of tags to be attached to the player.


Player Custom AttributesOBJECT

Optional

Key value pairs of any extra player attributes.


Referrer CodeSTRING

Optional

Referring player’s referral code. This is used in case of referral, where the player to be created is referred by the player having this code.


Level OrderNUMBER

Optional

The level order to place the player in. IMPORTANT: manual player leveling is available under special circumstances and is not available by default. Contact us for more info.


Device TokenSTRING

Optional

The FCM token (Firebase Cloud Messaging) needed for sending mobile push notifications. (Used only in case of mobile app)

This action allows you to track and send your players' events to Gameball.

Track Event is a Cloud action. The default Trigger is type = "track"

Property nameTypeRequiredDescription
Event NameSTRING
required

The name of the event


Event MetadataOBJECT

Optional

The event metadata to send to Gameball


Player IDSTRING
required

Unique identifier for the player in your database.


Mobile NumberSTRING

Optional

Player's unique mobile number.


EmailSTRING

Optional

Player's unique email.

This action used to track orders. They are designed specifically for E-Commerce Solutions.

Track Order is a Cloud action. The default Trigger is event = "Order Completed"

Property nameTypeRequiredDescription
Player IDSTRING
required

Unique identifier for the player in your database.


Mobile NumberSTRING

Optional

Player's unique mobile number.


EmailSTRING

Optional

Player's unique email.


Order IdSTRING
required

Unique order ID which identifies the underlying order in your system, e.g. order number, invoice number. It will be used for reversing any reward or redemption transaction on Gameball.


Order DateDATETIME
required

The date this order was placed, as an ISO8601 timestamp. Defaults to now if not provided.


Total PriceNUMBER
required

The sum of all order items' prices, including discounts, shipping, taxes, and tips. (Note: totalPaid is part of the totalPrice). Must be positive.


Total PaidNUMBER
required

The actual paid amount to the store. (Based on this amount, the player will be rewarded. Also, According to the Cashback Configuration). Must be positive.


Total ShippingNUMBER

Optional

The total shipping price of the order. Must be positive.


Total TaxNUMBER

Optional

The sum of all the taxes applied to the order in the shop currency. Must be positive.


Total DiscountNUMBER

Optional

Total discount applied on this order. Must be positive.


Line ItemsOBJECT

Optional

A list of line items, each containing information about an item in the order.


Discount CodesSTRING

Optional

An array of discount codes.


Redeemed AmountNUMBER

Optional

Monetary value of the redeemed points to be used by that player while placing his order. Note: If this field is set, then the holdReference value should be null. Also, both fields could be null.


Hold ReferenceSTRING

Optional

Hold reference ID received after calling Hold Points API. This is used in case you want to use already held points. Note: If this field is set, then the redeemedAmount value should be null. Also, both fields could be null.


GuestBOOLEAN

Optional

A boolean value indicating if the customer who placed this order is a guest. The default is false.


ExtraOBJECT

Optional

Key value pair(s) of any extra information about the order. The key values must be of type string or number


Merchant IdSTRING

Optional

Merchant unique id or code


Merchant NameSTRING

Optional

Merchant name


Branch IdSTRING

Optional

Branch unique id or code


Branch NameSTRING

Optional

Branch name


Migration from the classic Gameball destination

migration-from-the-classic-gameball-destination page anchor

Keep in mind if you plan to move to Gameball (Actions) from a classic Gameball destination that Gameball (Actions) uses Gameball's HTTP API v3.


You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo(link takes you to an external page).

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

(information)

Real-time to batch destination sync frequency

Real-time audience syncs to Gameball (Actions) may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
API Keypassword
required

Go to help center(link takes you to an external page) to learn how to find your API Key.


Secret Keypassword
required

Go to help center(link takes you to an external page) to learn how to find your API Key.