Add Subscriber with ReferralHero API

Pipedream makes it easy to connect APIs for ReferralHero and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Subscriber with the ReferralHero API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Add Subscriber with the ReferralHero API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Add Subscriber action
1. Connect your ReferralHero account
2. Select a List
3. Configure Email
4. Configure Domain
5. Optional- Configure Name
6. Optional- Configure Double Opt-in
7. Optional- Configure Source
8. Optional- Configure Referrer
9. Optional- Configure Conversion Value
10. Optional- Configure Pending
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Subscriber with ReferralHero API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ReferralHero

Try it

Add Subscriber with ReferralHero API on New Submission from Typeform API

Typeform + ReferralHero

Try it

Add Subscriber with ReferralHero API on Custom Events from Zoom API

Zoom + ReferralHero

Try it

Add Subscriber with ReferralHero API on New Submission (Instant) from Jotform API

Jotform + ReferralHero

Try it

Add Subscriber with ReferralHero API on New Scheduled Tasks from Pipedream API

Pipedream + ReferralHero

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Subscriber on ReferralHero

Description:Adds a new subscriber to to a list. [See the documentation](https://support.referralhero.com/integrate/rest-api/endpoints-reference#add-a-subscriber)

Version:0.0.1

Key:referralhero-add-subscriber

View on GitHub

Code#

import referralhero from "../../referralhero.app.mjs";

export default {
  key: "referralhero-add-subscriber",
  name: "Add Subscriber",
  description: "Adds a new subscriber to to a list. [See the documentation](https://support.referralhero.com/integrate/rest-api/endpoints-reference#add-a-subscriber)",
  version: "0.0.1",
  type: "action",
  props: {
    referralhero,
    listId: {
      propDefinition: [
        referralhero,
        "listId",
      ],
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the subscriber",
    },
    domain: {
      type: "string",
      label: "Domain",
      description: "The URL for the referral link",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the subscriber",
      optional: true,
    },
    doubleOptin: {
      type: "boolean",
      label: "Double Opt-in",
      description: "If set to `false`, the subscriber will not receive a confirmation email",
      default: true,
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "The source of the subscriber. Used for analytics.",
      optional: true,
    },
    referrer: {
      type: "boolean",
      label: "Referrer",
      description: "Set a referrer for the subscriber by providing the referrer's referral code or email",
      optional: true,
    },
    conversionValue: {
      type: "string",
      label: "Conversion Value",
      description: "The monetary value of the referral",
      optional: true,
    },
    pending: {
      type: "boolean",
      label: "Pending",
      description: "Set to `true` to set the referral status to pending",
      default: false,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.referralhero.addSubscriber({
      listId: this.listId,
      params: {
        email: this.email,
        name: this.name,
        double_optin: this.doubleOptin,
        source: this.source,
        referrer: this.referrer,
        domain: this.domain,
        conversion_value: this.conversionValue,
        status: this.pending
          ? "custom_event_pending"
          : undefined,
      },
      $,
    });

    if (response?.status === "error") {
      throw new Error(response.message);
    }

    if (response?.data?.id) {
      $.export("$summary", `Successfully added subscriber with ID ${response.data.id}.`);
    }

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
ReferralHero	`referralhero`	`app`	This component uses the ReferralHero app.
List	`listId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	Email address of the subscriber
Domain	`domain`	`string`	The URL for the referral link
Name	`name`	`string`	Name of the subscriber
Double Opt-in	`doubleOptin`	`boolean`	If set to `false`, the subscriber will not receive a confirmation email
Source	`source`	`string`	The source of the subscriber. Used for analytics.
Referrer	`referrer`	`boolean`	Set a referrer for the subscriber by providing the referrer's referral code or email
Conversion Value	`conversionValue`	`string`	The monetary value of the referral
Pending	`pending`	`boolean`	Set to `true` to set the referral status to pending