URL-based Conversion
Creates Referrals based on values in the page's URL string
Overview
This method creates a Referral based on parameters found in the URL string of the page.
Its primary use case is for when Referral data can only be retrieved from the URL string and the On-page Conversion method cannot be used.
Referral.js SDK Required
The webpage this method is on must have the Referral.js SDK installed to function.
Method Usage
The script below must be placed on the webpage following a successful conversion event (e.g. purchase confirmation or account dashboard page). This ensures the conversion event occurred and prevents Referrals from being created in error.
If the visitor who converted is associated to a Member, a Referral is created using the parameter values in the URL string.
For example, a parameter like emailParamName: "email", will cause the Referral.js SDK to retrieve [email protected] from the [email protected] portion of the URL example below.
`referralrock.com/trial/?uuid=345ak&email=[email protected]&amount=3&fName=bob
Use the script example below to get started.
<script type="text/javascript">
window.referralJS = ((window.referralJS !== null && window.referralJS !== undefined) ? window.referralJS : {});
window.referralJS.conversion = {
debug: "false",
parameters: {
externalIdentifierParamName: "enter uuid variable name from URL",
emailParamName: "enter email variable name from URL",
amountParamName: "enter amount variable name from URL",
firstNameParamName: "enter fName variable name from URL",
lastNameParamName: "enter lName variable name from URL"
}
};
</script>
Available Parameters
| Parameter | Details |
|---|---|
amountParamName | Required to trigger rewards based on the Referral's purchase amount and also allows for advanced data reporting. *Value should NOT include a currency code. |
emailParamName | Required for rewards and to send program emails. This or the externalIdentifierParamName is used to positively ID Referrals and protect against fraud. |
externalIdentifierParamName | Required for the Referral Update method if not using the emailParamName parameter. This should be a unique ID to connect the Referral to other systems (e.g. HubSpot). |
firstNameParamName | Used for Referral identification and communications with the first name merge tag. |
fullNameParamName | Can use this parameter instead of firstNameParamName and lastNameParamName. Referral Rock will parse the full name value. |
lastNameParamName | Used for Referral identification and communications with the last name merge tag. |
noteParamName | Private note only seen by program administrators. |
FAQ & Debug Help
Use the Integration Event Log to make sure Referrals and their information is being captured properly.
The Event Log displays all the integration events associated with the program. These events include conversion events and will show when the method is triggered.
Clicking the details icon for a Conversion event will show all of the data being passed by the script and confirm the desired parameters are being saved correctly.
There is also a debug setting on the script that can be set to true. When this is done, an iFrame will appear after the page loads as pictured here:
Debug mode example
Updated over 2 years ago