← ReferralHero

Add Subscriber with ReferralHero API

Pipedream makes it easy to connect APIs for ReferralHero and 2,000+ 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
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

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.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. 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

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.
LabelPropTypeDescription
ReferralHeroreferralheroappThis component uses the ReferralHero app.
ListlistIdstringSelect a value from the drop down menu.
Emailemailstring

Email address of the subscriber

Domaindomainstring

The URL for the referral link

Namenamestring

Name of the subscriber

Double Opt-indoubleOptinboolean

If set to false, the subscriber will not receive a confirmation email

Sourcesourcestring

The source of the subscriber. Used for analytics.

Referrerreferrerboolean

Set a referrer for the subscriber by providing the referrer's referral code or email

Conversion ValueconversionValuestring

The monetary value of the referral

Pendingpendingboolean

Set to true to set the referral status to pending

Authentication

ReferralHero uses API keys for authentication. When you connect your ReferralHero account, Pipedream securely stores the keys so you can easily authenticate to ReferralHero APIs in both code and no-code steps.

About ReferralHero

Everything you need to build, manage, and track a referral program‍... that doubles your business.

More Ways to Use ReferralHero

Triggers

New Subscriber Added from the ReferralHero API

Emit new event when a new subscriber is added

 
Try it

Actions

Track Referral Conversion Event with the ReferralHero API

Track a referral conversion event. Use when your Campaign Goal is set to track two or three conversion events. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.