Track Referd Events

Start sending your users' events on your platform to Referd.

Start sending your users' events on your app to Referd, along with any metadata that describes the event. Depending on your Referd programs configuration, the user can be rewarded based on the sent events.

Tracked events can be app events or server side events depending on how you would like to design your programs. App events can be sent via the available SDK interface and server-sdie events can be sent to Referd via the Track Events API.

Every Track Event call records a single user action. We call these “events”. We recommend that you make your event names human-readable, so that everyone can know what they mean instantly.

Event metadata are extra pieces of information you can tie to events you track. They can be anything that will be useful while designing your program.

To send Player events from your app to Referd, you can use the sendEvent method as shown below.

Parameter

Type

Required

Description

Event

Event Object

Yes

Event body that is being sent to Referd's dashboard.

CallBack

function

No

Callback is used for providing the developer with the status of the request as a boolean whether it succeeded or not or with an error if any.

SendEvent interface sends an Eventobject to Referd. Where the Eventobject is a wrapper holding a single or list of events. To add an event you should use the sendEvent method and pass to it theEventobject you have created.

SendEvent is a builder class that helps in creation of the Event with the common attributes mentioned below, all of these attributes are optional to use.

Method
Parameter Name
Type

AddUniquePlayerId

UniquePlayerId

String

AddEventName

eventName

string

AddEmail

email

string

AddMobile

mobileNumber

string

AddeventMetaData

(key, value)

(string, Object)

Event event = new Event.Builder()
        .AddUniquePlayerId("player123")
        .AddEventName("purchase_completed")
        .AddEmail("jack@domain.com")
        .AddMobile("0123456789")
        .AddEventMetaData("purchase_price", 19.99)
        .build();

Send the Event

Using the previously created GameballApp instance or by creating a new one, call the SendEvent() method as shown below.

gameballApp.sendEvent(event, new Callback<Boolean>() {
    @Override
    public void onSuccess(Boolean aBoolean) {
        // TODO Handle on success result
    }

    @Override
    public void onError(Throwable e) {
        // TODO Handle on failure result
    }
});

Last updated