ReferralHero

ReferralHero is a referral marketing platform for running refer-a-friend campaigns and tracking referrals, participants, and rewards. Nexla connects to the ReferralHero REST API to ingest lists, leaderboards, bonuses, and subscribers, and to write campaigns and subscriber records back to your ReferralHero account.

Power end-to-end data operations for your ReferralHero API with Nexla. Our bi-directional ReferralHero connector is purpose-built for ReferralHero, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to ReferralHero or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your ReferralHero workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a ReferralHero credential, you need an API token from your ReferralHero account. The ReferralHero REST API uses token-based authentication, with the token sent in the Authorization header using the Bearer scheme (Authorization: Bearer YOUR_API_TOKEN).

To obtain your API token, follow these steps:

1. Sign in to your ReferralHero dashboard.

2. Navigate to Account > API.

3. Locate your API token on this page. Copy the token value and store it securely, as you will need it to configure your Nexla credential.

Most ReferralHero endpoints operate on a specific referral list (campaign), which is identified by its list UUID. You can find the UUID for each of your lists in the ReferralHero dashboard. Keep the relevant list UUIDs on hand, as several source and destination endpoints require one to identify the campaign to read from or write to.

For more information about authentication and available endpoints, see the ReferralHero REST API reference.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key	Yes	Yes	API key used to authenticate requests to the ReferralHero API.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your ReferralHero API token in the API Key field. This is the token you obtained in Prerequisites from Account > API in your ReferralHero dashboard. Nexla sends this value in the Authorization header using the Bearer scheme for all API requests.

   Your API token grants access to your ReferralHero campaign data and should be treated as sensitive information. If your token is compromised, regenerate it from the Account > API page in your ReferralHero dashboard.

   For more information about authentication and available endpoints, see the ReferralHero REST API reference.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the ReferralHero connector tile, then select the credential that will be used to connect to your ReferralHero account, and click Next; or, create a new ReferralHero credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ReferralHero endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Lists

Retrieve lists.

• This endpoint returns the referral lists (campaigns) in your ReferralHero account. Use it to discover the list UUIDs required by the other ReferralHero endpoints.

For details about the response structure and available fields, see the ReferralHero REST API reference.

[Rest API] List Leaderboard

Retrieve leaderboard.

• This endpoint returns the leaderboard/ranking for a single referral list. Provide the List UUID of the ReferralHero list to retrieve the leaderboard for.

For details about the response structure and available fields, see the ReferralHero REST API reference.

[Rest API] List Bonuses

Retrieve bonuses.

• This endpoint returns the bonuses/rewards for a single referral list. Provide the List UUID of the ReferralHero list to retrieve bonuses for.

For details about the response structure and available fields, see the ReferralHero REST API reference.

[Rest API] List Subscribers

Retrieve subscribers.

• This endpoint returns the subscribers (referrers and referred participants) for a single referral list. Provide the List UUID of the ReferralHero list to retrieve subscribers for.

For details about the response structure and available fields, see the ReferralHero REST API reference.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

ReferralHero data sources can also be manually configured to ingest data from any valid ReferralHero API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new ReferralHero data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the ReferralHero destination, and select the Send to Destination option from the menu. Select the ReferralHero connector from the list of available destination connectors, then select the credential that will be used to connect to your ReferralHero account, and click Next; or, create a new ReferralHero credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ReferralHero endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create List

Create a new referral list/campaign in your ReferralHero account.

• This endpoint sends each record from your Nexset as a JSON request body to create a new referral list. The request body should contain the list properties in the format required by the ReferralHero API.

For details about the request body format and available list properties, see the ReferralHero REST API reference.

[Rest API] Add Subscriber

Add a new subscriber (referrer or referred participant) to a ReferralHero list.

• This endpoint sends each record from your Nexset as a JSON request body to add a subscriber to a referral list. Provide the List UUID of the ReferralHero list to add the subscriber to.

For details about the request body format and available subscriber properties, see the ReferralHero REST API reference.

[Rest API] Update Subscriber

Modify attributes of an existing subscriber on a ReferralHero list.

• This endpoint sends each record from your Nexset as a JSON request body to update an existing subscriber. Provide the List UUID of the ReferralHero list the subscriber belongs to and the Subscriber ID of the subscriber to update.

For details about the request body format and available subscriber properties, see the ReferralHero REST API reference.

[Rest API] Delete Subscriber

Remove a subscriber record from a ReferralHero list.

• This endpoint removes a subscriber from a referral list. Provide the List UUID of the ReferralHero list the subscriber belongs to and the Subscriber ID of the subscriber to remove.

For details about this operation, see the ReferralHero REST API reference.

Manual configuration

ReferralHero destinations can also be manually configured to send data to any valid ReferralHero API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured ReferralHero endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the ReferralHero endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.