Event Handlers for Real-Time Tracking in the Engine Mobile SDK
Instructions for using event handlers in the Engine Mobile SDK
Last updated
Instructions for using event handlers in the Engine Mobile SDK
Last updated
The Engine Mobile SDK has real-time Event Handlers so you can track lead progression through the flow in real time (accessing lead data and notifications when leads progress through each step of the SDK, up to and including offer click).
There are 6 Event Handlers you can implement that will be called as a user progresses through the SDK flow. Here is how you can implement them into your SDK implementation (you can choose any or all of these to implement):
{ your handler logic }
is a placeholder for any function you actually want to execute when that handler is called. Channel Partners typically use Event Handlers to call their own endpoints when leads hit specific funnel stages, for tracking, retargeting, or other purposes.
Each handler takes a structure object as an argument. Feel free to choose whichever arguments are useful to include in your handler logic, and omit the rest.
Below are descriptions of the various event handlers and the data each one has access to when it fires. All event handlers have access to timestamp
, which is a string representation of the moment (in UTC) the handler was called.
onInitialize
is called when the SDK is initialized, after any data saved to local storage has been loaded. The saved data is supplied to the handler. onInitialize
has access to the savedLeadUuid and savedLeadData, if the user's data was stored on the device from a previous session.
All page names provided to the handlers, such as page
, nextPage
, and editingPage
, will be in snake_case format.
*Note: PrefilledLeadData here here and for the rest of this page indicates the data type, i.e. what fields/data formats might be present. This will include all fields set on the lead at that point, regardless of whether the data was initially prefilled, or later submitted by the user.
onCreate
is called when the SDK first creates a lead with the Engine service. The data used to create the lead is supplied along with the current page and the page the user is editing, if any.
onUpdate
is called whenever the SDK updates a lead with the Engine service. It receives the same data that the onCreate handler receives.
onNavigate
is called whenever the user navigates to a new page. It receives the current lead data, the current page, the next page, and the page the user is editing if any.
onSubmit
is called when the user submits their information to the Engine service and receives offers. The submitted data is supplied to the handler.
s
onRateTableRender
is called when the user submits their information to the Engine service and receives offers. The submitted data is supplied to the handler.
onOfferClick
is called when the user submits their information to the Engine service and receives offers. The submitted data is supplied to the handler.
onExit
is called when the user attempts to exit the SDK flow. It is important to supply this handler in order to understand when the user exited the SDK and retarget the user to complete the flow.
All page names provided to the handlers, such as page
, nextPage
, and editingPage
, will be in snake_case format.
onInitialize
When the user first enters the SDK and reaches the splash page:
onInitialize
fires with:
onInitialize({ timestamp, storedLeadUuid,storedLeadData })
*Note: unless a lead has already begun, exited, and re-entered the SDK, storedLeadUuid
and storedLeadData
will be null
. If the user re-enters the SDK after a previous session where a leadUuid was created and leadData was stored in local storage on their device, the handler will fire with those values.
onNavigate
and onCreate
When the user navigates to the following screen (which differs depending how much user info is prefilled), onNavigate
and onCreate
will fire. For example, if no info is prefilled, the user will navigate away from the splash screen, where onNavigate
fires:
onNavigate({ timestamp, leadUuid, leadData, currentPage, nextPage })
Values will be as follows:
leadUuid: null (unless the user returned from a previous session, where the leadUuid
was stored in local storage)
leadData: any user info prefilled, e.g. {firstName: "Bob", lastName: "Dylan", email: "bobdylan@tambourineman.com", {...other prefilled data, if provided}}
currentPage: splash
nextPage: loan_amount
onCreate({ timestamp, leadUuid, leadData, createPage })
Values will be as follows:
leadData: {firstName: "Bob", lastName: "Dylan", email: "bobdylan@tambourineman.com", ipAddress: "x.x.x.x"}
createPage: splash
The user will then navigate into the loan_amount
screen (again, assuming loanAmount
is not prefilled):
When the user presses Continue
, onNavigate
will fire:
onNavigate({ timestamp, leadUuid, leadData, currentPage, nextPage })
Values will be as follows:
leadUuid: {the lead's UUID as a string}
leadData: {"firstName":"Bob","lastName":"Dylan","email":"bobdylan@tambourineman.com","ipAddress":"x.x.x.x"}
currentPage: loan_amount
nextPage: loan_purpose
The lead is also updated at this point, so onUpdate
fires:
onUpdate({ timestamp, leadUuid, leadData, page })
Values will be as follows:
leadUuid: {the lead's UUID as a string}
leadData: {"firstName":"Bob","lastName":"Dylan","email":"bobdylan@tambourineman.com","ipAddress":"x.x.x.x","loanAmount":5000}
page: loan_amount
onNavigate
and onUpdate
callsonNavigate
and onUpdate
will fire at each user navigation, with the leadData
object growing as fields are updated onto the lead. currentPage
/ nextPage
values are as follows:
loan_purpose
date_of_birth
address
phone
credit_rating
property_status
education_level
employment_status
annual_income
ssn
confirm_details
offers
onSubmit
When the user presses See my offers
on the confirm_details screen:
The Event Handlers that fire are:
onSubmit({ timestamp, leadUuid, leadData })
onNavigate({ timestamp, leadUuid, leadData, currentPage, nextPage })
onUpdate({ timestamp, leadUuid, leadData, page })
currentPage
and page
here will = confirm_details
nextPage
will = offers
onRateTableRender
When the user lands on the offer page, onRateTableRender
fires with a rateTableUuid
, a leadUuid
, and two arrays: loanOffers
and specialOffers
rateTableUuid
This is associated with that application from that lead. Useful to identify and map with the leadUuid
.
loanOffers
This is an array of objects. Each object will have the following attributes:
offerUuid
financialInstitutionName
financialInstitutionUuid
productType
productSubType
loanAmount
apr
termLength
monthlyPayment
specialOffers
This is an array of objects. Each object has the following attributes:
offerUuid
name
financialInstitutionName
financialInstitutionUuid
productSubType
onOfferClick
onOfferClick fires when a lead clicks on an offer from the offer table. The financialInstitutionName
, productType
, and productSubType
will indicate whether the user clicked a loan offer or special offer.
When some user info is prefilled, the first onNavigate
fire away from the splash screen will have:
currentPage=splash
nextPage={the first page in the flow that was not prefilled}
The rest of the flow will be the same as Scenario 1 above.
When some user info is prefilled, the first onNavigate
fire on the first navigation away from the splash screen will have:
currentPage=splash
nextPage=confirm_details
onCreate
will also fire at this point, since this is when the leadUuid
is created by posting the lead to the Engine API.
The user will submit by pressing See my offers
, and onSubmit
, onNavigate
, and onUpdate
will function the same as in Scenario 1.
Note: onUpdate
will still fire when the user presses See my offers
on the confirm_details screen because this is when legal consents are accepted / set to the lead object.
onExit
- wherever a user exits the flowonExit
will fire whenever a user leaves the Engine Mobile SDK, regardless of where in the flow the user left the flow. You can use this to infer whether a lead completed / submitted the loan form, depending what other Event Handler callbacks have fired (assuming you set those up as well). More details in the next section:
Event handlers can be used to track how far a lead progressed in the flow, i.e. if your Event Handler callbacks fire an onExit
but do not fire an onSubmit
, and/or if your onNavigate
handlers never fire with nextPage=offers
, you can infer that the lead exited the flow before submitting to see offers. This allows you to retarget the lead accordingly to entice them to complete the form and see their offers.
leadUuid: {UUID string in UUID Format}
()
Similarly, if your Event Handler fires indicate the lead submitted the form (i.e. onSubmit
fires and/or onNavigate
fires with nextPage=offers
, but you do not receive reporting/notifications that the lead converted on a loan or other product, you may retarget the lead to entice them to re-enter the SDK, immediately see their offers (since on re-entry the user will be directed straight to the offers
screen, and ideally convert on an available offer. See for your available options for receiving conversion reporting from Engine by MoneyLion.