How to use the Linkrunner SDK in your React Native app
App.tsx
component:
You can find your project token here.
secretKey
: A unique secret key used for request signing and authenticationkeyId
: A unique identifier for the key pair used in the signing processgetAttributionData
method.
signup
method once after the user has completed your app’s onboarding process:
It is strongly recommended to use the integrated platform’s identify function to set a persistent user_id once it becomes available (typically after signup or login).
getAttributionData
function:
getAttributionData
function returns:
setUserData
each time the app opens and the user is logged in:
setAdditionalData
method to set CleverTap ID:
linkrunner.setAdditionalData
clevertapId
: string (optional) - CleverTap user identifieramount
parameter as a number in your custom event data. This allows the ad networks to optimize campaigns based on the revenue value of conversions:
amount
parameter is passed as a number, not as a
string.linkrunner.capturePayment
amount
: number (required) - The payment amountuserId
: string (required) - Identifier for the user making the paymentpaymentId
: string (optional) - Unique identifier for the paymenttype
: string (optional) - Type of payment. Available options:
FIRST_PAYMENT
- First payment made by the userSECOND_PAYMENT
- Second payment made by the userWALLET_TOPUP
- Adding funds to a walletFUNDS_WITHDRAWAL
- Withdrawing fundsSUBSCRIPTION_CREATED
- New subscription createdSUBSCRIPTION_RENEWED
- Subscription renewalONE_TIME
- One-time paymentRECURRING
- Recurring paymentDEFAULT
- Default type (used if not specified)status
: string (optional) - Status of the payment. Available options:
PAYMENT_INITIATED
- Payment has been initiatedPAYMENT_COMPLETED
- Payment completed successfully (default if not specified)PAYMENT_FAILED
- Payment attempt failedPAYMENT_CANCELLED
- Payment was cancelledLinkrunner.removePayment
userId
: String (required) - Identifier for the user whose payment is being removedpaymentId
: String (optional) - Unique identifier for the payment to be removedpaymentId
or userId
must be provided when calling removePayment
. If only userId
is provided, all payments for that user will be removed.
Function | Where to Place | When to Call |
---|---|---|
linkrunner.init | App.tsx within useEffect | Once when app starts |
linkrunner.getAttributionData | Attribution data handling flow | Whenever the attribution data is needed |
linkrunner.setAdditionalData | Integration code | When third-party integration IDs are available |
linkrunner.signup | Onboarding flow | Once after user completes onboarding |
linkrunner.setUserData | Authentication logic | Every time app opens with logged-in user |
linkrunner.trackEvent | Throughout app | When specific user actions occur |
linkrunner.capturePayment | Payment processing | When user makes a payment |
linkrunner.removePayment | Refund flow | When payment needs to be removed |