¶ Splynx referral system
- Overview
- Installation
- Configuration
- Display it on the portal dashboard
- How to create new customers to trigger the referral system
- Reports
- Troubleshooting
¶ Overview
Ready to boost customer acquisition and build subscriber loyalty? Our Referral System add-on is designed with ISPs like you in mind. Here's how it can benefit your business:
Benefits for ISPs:
- Customer Growth: Harness the power of your existing customers to bring in new subscribers.
- Build Loyalty: Reward your customers for helping your customer base grow.
- Streamlined Tracking: Monitor referrals and bonuses effortlessly with our automated reports.
- Tailored to Your Requirements: Customize the referral program to fit your specific ISP business needs.
How It Works:
- Customers Refer Friends: Your customer has a unique identifier - ID. Ask your friend to provide this code during registration.
- Friends Sign Up: During registration, a new customer can provide this ID (of a friend who invited them to join) as a referral code.
- Activation of a New Customer: After successful registration, your friend has a time limit to activate their account in Splynx. The amount of days to activate is configurable (40 by default).
- Bonuses for All: After activation within that time frame, both the referring customer and the new subscriber receive bonuses (configurable).
- Manage with Ease: Keep a close eye on referral activity and bonus management through our reports.
The bonus is applied only if both the Referrer and the Referred have Active status.
With the Referral System add-on, you empower your ISP customers to become advocates for your services. Grow your subscriber base organically and reward your loyal customers for helping your community thrive.
¶ Installation
¶ Configuration
- Referral bonus One-time tariff – specify a one-time tariff from which the bonus will be added. The system will create a credit note as a bonus with this tariff plan;
- Referral bonus application type – specify who will receive the bonus: the Referrer, or both the Referee and the Referrer;
- Bonus time expiration (in days) – enter the number of days after which the bonus will expire if the customer is not activated in the system (i.e., their status is not 'Active' during this period);
- Source - choose the available sources of customers that will be included in the referral process;
- API keys to track - choose the API keys you want to track. Customers created using the selected API keys will be eligible for the referral feature, while others will not;
- Invitation email template – choose an email template to be sent to the invited user. To edit this template, navigate to
Config → Templates, select the "Email" type` and find the necessary template. Paste this code with the variables:
Hello {referee_name}, you've been invited to join by {{customer.name}}. Your referral code is {{customer.id}}. Also, {{customer.name}} left you a message, here it is: {invitation_message}
- Credit note email template – select a template to be sent to the customer along with the credit note. To edit this template, navigate to
Config → Templates, select the "Email" type, and find the necessary template.
¶ Display it on the portal dashboard
You can customize the text in the 'Code' field. Please edit only the plain text, but do not modify the actual code. Feel free to edit the highlighted text:
This entry point is located on the portal dashboard and enables your customers to invite a friend via the 'Invite' button, which triggers Splynx to send an email to the referee. Customers can also view referral statistics using the 'View report' button.
¶ How it works
Here, you have to provide your friend's email address, their name, and optionally a personalized message.
This page lists every invite the customer has sent through the Invite form, together with its current status and the total bonus the customer has earned from successful referrals. Both invites that are still waiting for the recipient to register and referrals that already produced a Splynx customer are shown side by side:
Each row in the table represents either a sent invite or a referred customer who has already registered. The most relevant columns are:
- Invite date — date and time the invite was sent from the Invite form.
- Email — the recipient's email address.
- Name — the name entered in the Friend's name field of the Invite form. Shows
-when the field was left blank. Once the recipient registers in Splynx, the invite row is replaced with a single referral row that uses the actual customer's name instead. - Status — current state of the invite. Possible values:
- Invite sent — the email has been delivered, but the recipient has not registered in Splynx yet.
- Pending — the recipient has registered (with the inviter's ID set in the Referrer field), but their account is not yet Active, so no bonus has been issued.
- Yes — the recipient registered and their account became Active; the bonus has been applied.
- [DELETED] — a previously registered referred customer has been removed from Splynx.
The same recipient email can receive more than one invite. Repeat invites appear as separate Invite sent rows; when the recipient finally registers, all of those rows collapse into a single referral record (status Pending or Yes). A fresh invite sent to that email afterwards appears as a new Invite sent row and is tracked independently.
Customers who register through the direct referral link (without an emailed invite) also appear in the table — they show up directly with status Pending or Yes, without a preceding Invite sent row.
Every sent invite is logged on the Portal report immediately with status Invite sent. An invite is counted as a referral — and becomes eligible for a bonus — only after the recipient registers in Splynx and the inviting customer's ID is set in the Referrer field on the new customer:
Sending a message to the customer does not affect the referral status. The status changes only after the referred account is activated. Until this, the referral will remain in Pending status.
¶ How to create new customers to trigger the referral system
The idea is simple - create a customer with the ID of the referrer in this field:
It can be done in multiple ways:
1. Manually create a customer with the referrer code:
2. Using a sign-up widget
First of all, you need to include the "Referrer" field into the sign-up widget form. To do so, navigate to Config → Leads → Signup widget and scroll down to the "Form fields" table. Click "+" button to add a new field, and select the "Referrer" field:
Save the changes and copy the code of our sign-up widget and place it somewhere on your website.
Now your customers can register via this form on your website and set the referrer code:
After the registration, a new lead will be created.
Convert that customer into an active customer, and the referral system add-on will trigger the bonus to apply.
3. Using a registration form
If you use a custom registration form that creates customers through the API, or if you create customers directly via the API, ensure that the API key is enabled for tracking in the referral system under the module configuration settings:
If so, all customers created by that API key will be included in the referral system.
¶ Reports
You can find the referral system report under Administration → Other reports → Referral system report:
This report displays all customers that were tracked by the referral system for the selected period of time. Both pending and successful referrals are displayed here. Pending referrals have empty "Referrer bonus", "Referee bonus", "Credit note date" and the "Activation date" fields. Unlike the customer-facing Portal report, this admin report does not list invites that have not yet produced a registered customer — it only includes recipients that signed up with the inviter's ID in the Referrer field.
¶ Troubleshooting
The causes of errors in the referral system can be found in Config → Integrations → Hooks:
Common errors include:
'This hook triggered by not allowed source'
This error occurs when the Source value in the configuration does not match the Source of the referred user:
'This hook triggered by not allowed author'
This occurs when the API key used to create the customer is not included in the list of allowed API keys (API keys to track).
'This referee already exists in database'
This occurs when the referred user has already received the bonus.