• Documentation >
• Apps >
• Marketing >
• ReferralHero

ReferralHero

The ReferralHero modules allow you to monitor, create, update, list, and delete the subscribers, referrals, rewards, and lists in your ReferralHero account.

Getting Started with ReferralHero

Prerequisites

• A ReferralHero account

In order to use ReferralHero with Ibexa Connect, it is necessary to have a ReferralHero account. If you do not have one, you can create a ReferralHero account at referralhero.com.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting ReferralHero to Ibexa Connect

To connect your ReferralHero account to Ibexa Connect you need to obtain the API Key from your ReferralHero account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your ReferralHero account and open your Dashboard.

2. Click Account > API.

   

3. Copy the API token to your clipboard.

   

4. Go to Ibexa Connect and open the ReferralHero module's Create a connection dialog.

   

5. In the Connection name field, enter a name for the connection.

6. In the API Token field, enter the token details copied in step 3, and click Continue.

The connection has been established.

Subscribers

See the Setting Up the ReferralHero Webhooks to add the webhook in your ReferralHero account.

Watch New Subscribers added to your campaign.

Triggers when a new subscriber is added to your campaign.

Webhook Name	Enter a name for the webhook.

Watch Deleted Subscribers

Triggers when a subscriber is deleted from your campaign.

Webhook Name	Enter a name for the webhook.

List Subscribers

Gets all the subscribers on a list.

List UUID	Select the List unique identifier (UUID) whose subscribers you want to list.
Sort By	Select the option to sort the subscribers. For example, Name in Ascending Order.
Limit	Set the maximum number of subscribers Ibexa Connect should return during one scenario execution cycle.

Get a Subscriber

Retrieves a subscriber.

List UUID	Select the List unique identifier (UUID) whose subscribers you want to list.
Search By	Select the option to search the subscriber: Email ID
Email	Select the email address of the subscriber whose details you want to retrieve. Only verified subscribers can be retrieved. If you try to retrieve a non-verified subscriber, it will return a subscriber_not_found error.
ID	Select the ID of the subscriber whose details you want to retrieve.Only verified subscribers can be retrieved. If you try to retrieve a non-verified subscriber, it will return a subscriber_not_found error.

Create a Subscriber

Creates a new subscriber.

List UUID	Select the List ID in which you want to create a subscriber.
Email	Enter teh subscriber's email address.
Hosting URL	Enter the campaign URL address from which the subscriber had subscribed.
Name	Enter the subscriber name.
Extra Field	Enter any additional field for the subscriber. For example, subscriber phone number.
Extra Field 1	Enter any additional field for the subscriber. For example, subscriber phone number.
Referral	Enter a referrer for the subscriber by providing the referrer's referral code or email.
Points	Enter the number of points allocated for the subscriber. This field is applicable only for contest campaigns.
Double Optin	Select whether the subscriber had opted in for receiving the notifications for the confirmation.
Source	Enter teh source from where the subscriber has signed up. For example, webinar.
Device	Enter teh device details used by the subscriber to sign up.
Transaction ID	Enter the Transaction ID of the subscriber subscription. This information is useful when tracking referrals for purchases.
Conversion Strategy	Enter the referral type. This information is used for creating reports.
Conversion Value	Enter the referral amount.

Update a Subscriber

Updates a subscriber.

List UUID	Select the List ID in which you want to create a subscriber.
Subscriber ID	Select the Subscriber ID whose details you want to update. Only verified subscribers can be retrieved. Trying to retrieve a non-verified subscriber will return a subscriber_not_found error.
Email	Enter teh subscriber's email address.
Name	Enter the subscriber name.
Extra Field	Enter any additional field for the subscriber. For example, subscriber phone number.
Extra Field 1	Enter any additional field for the subscriber. For example, subscriber phone number.
Points	Enter the number of points allocated for the subscriber. This field is applicable only for contest campaigns.

Delete a Subscriber

Deletes a subscriber.

List UUID	Select the List unique identifier (UUID) whose subscriber's details you want to delete.
Subscriber ID	Select the Subscriber ID you want to delete.

Referrals

Confirm a Referral

Confirms a Referral.

List UUID	Select the List unique identifier (UUID) whose subscriber's referral you want to confirm.
Subscriber ID	Select the subscriber ID whose referral you want to confirm. Only verified subscribers can be retrieved. If you try to retrieve a non-verified subscriber, it will return a subscriber_not_found error.

Lists

List Lists

Gets all the lists/campaigns in your account.

Limit	Set the maximum number of lists Ibexa Connect should return during one scenario execution cycle.

Create a List

Creates all the lists/campaigns in your account.

Name	Enter a name for the list.
Website	Enter the URL address of the campaign referral.

Rewards

See the Setting Up the ReferralHero Webhooks to add the webhook in your ReferralHero account.

Watch Unlocked Rewards

Triggers when a subscriber unlocks a reward.

Webhook Name	Enter a name for the webhook.

List Rewards

Gets a list of rewards.

List UUID	Select the List ID whose rewards you want to list.
Limit	Set the maximum number of lists Ibexa Connect should return during one scenario execution cycle.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://app.referralhero.com/api. For example: /v2/lists

For the list of available endpoints, refer to the ReferralHero API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Subscribers

The following API call returns all the subscribers from your ReferralHero account:

URL:

/v2/lists/<list_UUID>/subscribers

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > data > subscribers.

In our example, 3 subscribers were returned:

Setting Up the ReferralHero Webhooks

1. Open any Watch module, establish a connection as mentioned in the respective modules, click Save and copy the URL address to your clipboard. Click OK and save the trigger.

   

2. Log in to your ReferralHero account.

3. Select the campaign for which you want to add the webhooks.

4. Click Installation Instructions > Integrations > Webhooks > +New Webhook.

5. Add the URL address copied in step 1 and select the events for which you want to receive the triggers. When you add the URL address in the URL field, remove the prefix https:// as the copied URL already has that part.

6. Click Create Webhook.

   

You have successfully added the webhook.

Go to Ibexa Connect and run the webhook scenario to receive the triggers for the selected events.