Create Affiliate with Refersion API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Affiliate with the Refersion API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Affiliate action
1. Connect your Refersion account
2. Configure First Name
3. Configure Last Name
4. Configure Email
5. Configure Password
6. Select a Status
7. Optional- Configure Offer
8. Optional- Configure Company
9. Optional- Configure Paypal Email
10. Optional- Configure Address 1
11. Optional- Configure Address 2
12. Optional- Configure City
13. Optional- Configure State
14. Optional- Configure Zip
15. Optional- Select a Country
16. Optional- Configure Phone
17. Optional- Configure Send Welcome
18. Optional- Configure Conversion Trigger Coupon
19. Optional- Configure Unique Merchant ID
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Affiliate on Refersion

Description:Create a new affiliate. [See the docs here](https://www.refersion.dev/reference/new_affiliate)

Version:0.0.1

Key:refersion-create-affiliate

View on GitHub

Refersion Overview#

The Refersion API gives you the power to build secure and feature-rich
applications that extend the functionality of the Refersion platform. With the
Refersion API, you can create applications that target referral and affiliate
marketing campaigns, product promotions, and other marketing initiatives.

You can use the Refersion API to:

Automate referral and affiliate marketing campaigns
Create product promotions
Access sales tracking reports
Create affiliate links
Monitor performance of campaigns
Integrate with third-party applications
Create custom dashboards to report on marketing initiatives
Track user referrals
Create custom tools for affiliates and merchants
Create promotions and discount codes
Manage subscriber data
Monitor promotional and coupon codes
Generate referral links
Automatically create accounts
Manage payment schedules
Track sales and payments
Build real-time analytics and reporting on campaigns
Create reports for performance optimization
Monitor customer interactions
Send notifications to affiliates
Create personalization for users
Set access levels for affiliates and merchants
Monitor and approve affiliate applications
Automatically generate coupon codes
Manage customer relationships
Generate reports to measure ROI
Create custom landing pages
Customize the branding of applications

Action Code#

import app from "../../refersion.app.mjs";
import options from "../../common/options.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Create Affiliate",
  description: "Create a new affiliate. [See the docs here](https://www.refersion.dev/reference/new_affiliate)",
  key: "refersion-create-affiliate",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the affiliate",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the affiliate",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email of the affiliate",
    },
    password: {
      type: "string",
      label: "Password",
      description: "Has at least 9 characters. The password is NOT more than 72 characters. Has at least 1 upper case character. Has at least 1 lower case character. Has at least 1 numerical character. Has at least 1 special character. Does NOT have the same character repeated more than 3 times in a row. Password does NOT match the email of the user.",
    },
    status: {
      type: "string",
      label: "Status",
      description: "Status of the affiliate",
      options: options.AFFILIATE_STATUS,
    },
    offer: {
      type: "string",
      label: "Offer",
      description: "Specific Offer ID to opt affiliate into, otherwise your default offer is used.",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "Company of the affiliate",
      optional: true,
    },
    paypalEmail: {
      type: "string",
      label: "Paypal Email",
      description: "Paypal email of the affiliate",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "Address 1 of the affiliate",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "Address 2 of the affiliate",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City of the affiliate",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State of the affiliate",
      optional: true,
    },
    zip: {
      type: "string",
      label: "Zip",
      description: "Zip of the affiliate",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country of the affiliate",
      optional: true,
      options: options.COUNTRIES,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone of the affiliate",
      optional: true,
    },
    sendWelcome: {
      type: "boolean",
      label: "Send Welcome",
      description: "Send welcome email to affiliate",
      optional: true,
    },
    conversionTriggerCoupon: {
      type: "string",
      label: "Conversion Trigger Coupon",
      description: "A unique coupon code to assign to this affiliate as a conversion trigger.",
      optional: true,
    },
    uniqueMerchantId: {
      type: "string",
      label: "Unique Merchant ID",
      description: "An optional alphanumeric identifier for the affiliate for your team's internal use.",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      first_name: this.firstName,
      last_name: this.lastName,
      email: this.email,
      password: this.password,
      status: this.status,
      offer: this.offer,
      company: this.company,
      paypal_email: this.paypalEmail,
      address1: this.address1,
      address2: this.address2,
      city: this.city,
      state: this.state,
      zip: this.zip,
      country: this.country,
      phone: this.phone,
      send_welcome: this.sendWelcome
        ? "TRUE"
        : "FALSE",
      conversion_trigger_coupon: this.conversionTriggerCoupon,
      unique_merchant_id: this.uniqueMerchantId,
    };
    const res = await this.app.createAffiliate(data, $);
    if (res.error) {
      throw new ConfigurationError(res.error);
    }
    $.export("$summary", `Affiliate successfully created with id "${res.id}"`);
    return res;
  },
};

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
Refersion	`app`	`app`	This component uses the Refersion app.
First Name	`firstName`	`string`	First name of the affiliate
Last Name	`lastName`	`string`	Last name of the affiliate
Email	`email`	`string`	Email of the affiliate
Password	`password`	`string`	Has at least 9 characters. The password is NOT more than 72 characters. Has at least 1 upper case character. Has at least 1 lower case character. Has at least 1 numerical character. Has at least 1 special character. Does NOT have the same character repeated more than 3 times in a row. Password does NOT match the email of the user.
Status	`status`	`string`	Select a value from the drop down menu:`PENDINGACTIVE`
Offer	`offer`	`string`	Specific Offer ID to opt affiliate into, otherwise your default offer is used.
Company	`company`	`string`	Company of the affiliate
Paypal Email	`paypalEmail`	`string`	Paypal email of the affiliate
Address 1	`address1`	`string`	Address 1 of the affiliate
Address 2	`address2`	`string`	Address 2 of the affiliate
City	`city`	`string`	City of the affiliate
State	`state`	`string`	State of the affiliate
Zip	`zip`	`string`	Zip of the affiliate
Country	`country`	`string`	Select a value from the drop down menu:`{ "value": "US", "label": "United States" }{ "value": "AE", "label": "United Arab Emirates" }{ "value": "AR", "label": "Argentina" }{ "value": "AS", "label": "American Samoa" }{ "value": "AT", "label": "Austria" }{ "value": "AU", "label": "Australia" }{ "value": "BA", "label": "Bosnia and Herzegovina" }{ "value": "BD", "label": "Bangladesh" }{ "value": "BE", "label": "Belgium" }{ "value": "BG", "label": "Bulgaria" }{ "value": "BR", "label": "Brazil" }{ "value": "CA", "label": "Canada" }{ "value": "CH", "label": "Switzerland" }{ "value": "CL", "label": "Chile" }{ "value": "CN", "label": "China" }{ "value": "CO", "label": "Colombia" }{ "value": "CR", "label": "Costa Rica" }{ "value": "CZ", "label": "Czech Republic" }{ "value": "DE", "label": "Germany" }{ "value": "DK", "label": "Denmark" }{ "value": "DZ", "label": "Algeria" }{ "value": "EE", "label": "Estonia" }{ "value": "ES", "label": "Spain" }{ "value": "FI", "label": "Finland" }{ "value": "FM", "label": "Micronesia, Federated States of" }{ "value": "FO", "label": "Faroe Islands" }{ "value": "FR", "label": "France" }{ "value": "GB", "label": "United Kingdom" }{ "value": "GH", "label": "Ghana" }{ "value": "GR", "label": "Greece" }{ "value": "GU", "label": "Guam" }{ "value": "HK", "label": "Hong Kong" }{ "value": "HN", "label": "Honduras" }{ "value": "HR", "label": "Croatia" }{ "value": "HU", "label": "Hungary" }{ "value": "ID", "label": "Indonesia" }{ "value": "IE", "label": "Ireland" }{ "value": "IL", "label": "Israel" }{ "value": "IM", "label": "Isle of Man" }{ "value": "IN", "label": "India" }{ "value": "IS", "label": "Iceland" }{ "value": "IT", "label": "Italy" }{ "value": "JM", "label": "Jamaica" }{ "value": "JP", "label": "Japan" }{ "value": "KR", "label": "South Korea" }{ "value": "KW", "label": "Kuwait" }{ "value": "LT", "label": "Lithuania" }{ "value": "LU", "label": "Luxembourg" }{ "value": "LV", "label": "Latvia" }{ "value": "MA", "label": "Morocco" }{ "value": "MH", "label": "Marshall Islands" }{ "value": "MK", "label": "North Macedonia" }{ "value": "MP", "label": "Northern Mariana Islands" }{ "value": "MT", "label": "Malta" }{ "value": "MX", "label": "Mexico" }{ "value": "MY", "label": "Malaysia" }{ "value": "NG", "label": "Nigeria" }{ "value": "NL", "label": "Netherlands" }{ "value": "NO", "label": "Norway" }{ "value": "NZ", "label": "New Zealand" }{ "value": "OM", "label": "Oman" }{ "value": "PE", "label": "Peru" }{ "value": "PH", "label": "Philippines" }{ "value": "PK", "label": "Pakistan" }{ "value": "PL", "label": "Poland" }{ "value": "PR", "label": "Puerto Rico" }{ "value": "PT", "label": "Portugal" }{ "value": "PW", "label": "Palau" }{ "value": "QA", "label": "Qatar" }{ "value": "RO", "label": "Romania" }{ "value": "RS", "label": "Serbia" }{ "value": "RU", "label": "Russia" }{ "value": "SA", "label": "Saudi Arabia" }{ "value": "SE", "label": "Sweden" }{ "value": "SG", "label": "Singapore" }{ "value": "SI", "label": "Slovenia" }{ "value": "SK", "label": "Slovakia" }{ "value": "SV", "label": "El Salvador" }{ "value": "TH", "label": "Thailand" }{ "value": "TN", "label": "Tunisia" }{ "value": "TR", "label": "Turkey" }{ "value": "TW", "label": "Taiwan" }{ "value": "TZ", "label": "Tanzania" }{ "value": "UA", "label": "Ukraine" }{ "value": "UY", "label": "Uruguay" }{ "value": "VG", "label": "British Virgin Islands" }{ "value": "VI", "label": "U.S. Virgin Islands" }{ "value": "VN", "label": "Vietnam" }{ "value": "WS", "label": "Samoa" }{ "value": "ZA", "label": "South Africa" }`
Phone	`phone`	`string`	Phone of the affiliate
Send Welcome	`sendWelcome`	`boolean`	Send welcome email to affiliate
Conversion Trigger Coupon	`conversionTriggerCoupon`	`string`	A unique coupon code to assign to this affiliate as a conversion trigger.
Unique Merchant ID	`uniqueMerchantId`	`string`	An optional alphanumeric identifier for the affiliate for your team's internal use.

Action Authentication#

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

To retrieve your Refersion Public and Secret keys,

Navigate to your Refersion account and sign in
Go to “Account” > “Settings” > “Refersion API” > “Refersion API Keys”

About Refersion#

Manage and track your ambassador, influencer and affiliate marketing programs with ease.

More Ways to Connect Refersion + Pipedream#

Other Popular Integrations#

Get Affiliate with Refersion API on New Scheduled Tasks from Pipedream API

Pipedream + Refersion

Try it

Manual Comission Credit with Refersion API on New Scheduled Tasks from Pipedream API

Pipedream + Refersion

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Upcoming Event Type Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event of the specified type ("default", "focusTime", "outOfOffice", "workingLocation") in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it