Add Subscriber with ReferralHero API on New Sent Email from Gmail API

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

Trigger workflow on

New Sent Email from the Gmail API

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#

This integration creates a workflow with a Gmail trigger and ReferralHero action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Sent Email trigger
1. Connect your Gmail account
2. Configure timer
3. Optional- Configure Search Query
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Sent Email on Gmail

Description:Emit new event for each new email sent. (Maximum of 100 events emited per execution)

Version:0.0.11

Key:gmail-new-sent-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";

export default {
  ...common,
  key: "gmail-new-sent-email",
  name: "New Sent Email",
  description: "Emit new event for each new email sent. (Maximum of 100 events emited per execution)",
  version: "0.0.11",
  type: "source",
  dedupe: "unique",
  props: {
    gmail,
    ...common.props,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
  },
  methods: {
    ...common.methods,
    getLabels() {
      return [
        "SENT",
      ];
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: message.snippet,
        ts: +message.internalDate,
      };
    },
  },
};

Trigger 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
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators

Trigger Authentication#

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

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

ReferralHero Overview#

The ReferralHero API allows you to build custom referral marketing campaigns, manage participants, and track referral performance directly from Pipedream. You can automate participant registration, reward distribution, and integrate with other services for enhanced functionality like email marketing, CRM updates, or analytics. By leveraging Pipedream’s serverless platform, you can create workflows that react to events in ReferralHero, enrich referral data, or synchronize it with other apps.

Action 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;
  },
};

Action Configuration#

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

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

Action 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 Connect ReferralHero + Gmail#

Other Popular Integrations#

Add Subscriber with ReferralHero API on New Labeled Email from Gmail API

Gmail + ReferralHero

Add Subscriber with ReferralHero API on New Sent Email from Gmail API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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