Add Contact with UpViral API on New Transaction from OANDA API

Pipedream makes it easy to connect APIs for UpViral, OANDA and 2,500+ other apps remarkably fast.

Trigger workflow on

New Transaction from the OANDA API

Next, do this

Add Contact with the UpViral 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 OANDA trigger and UpViral action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Transaction trigger
1. Connect your OANDA account
2. Configure timer
3. Configure Is Demo
4. Select a Account ID
5. Optional- Select a Type
Configure the Add Contact action
1. Connect your UpViral account
2. Select a Campaign Id
3. Configure Email
4. Optional- Configure Name
5. Optional- Configure IP Address
6. Optional- Configure Referral Code
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 Transaction on OANDA

Description:Emit new event whenever a trade is executed in the user's account. [See the documentation](https://developer.oanda.com/rest-live-v20/transaction-ep/)

Version:0.0.1

Key:oanda-new-transaction

View on GitHub

OANDA Overview#

The OANDA API enables you to tap into the world of forex trading, providing real-time currency exchange rates, and the ability to automate trading strategies, manage accounts, access market data, and more. On Pipedream, you can craft workflows that capitalize on OANDA's capabilities, such as reacting to market changes, automating trades based on custom logic, and syncing forex data with other business applications for analysis and decision-making.

Trigger Code#

import common from "../common/base.mjs";
import constants from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "oanda-new-transaction",
  name: "New Transaction",
  description: "Emit new event whenever a trade is executed in the user's account. [See the documentation](https://developer.oanda.com/rest-live-v20/transaction-ep/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    type: {
      type: "string",
      label: "Type",
      description: "Filter results by transaction type",
      options: constants.TRANSACTION_TYPES,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    async processEvent(max) {
      const lastId = this._getLastId();
      const params = {
        type: this.type,
        from: lastId,
        to: lastId + constants.DEFAULT_LIMIT,
      };
      let total, results = [];

      do {
        const { transactions } = await this.oanda.listTransactions({
          isDemo: this.isDemo,
          accountId: this.accountId,
          params,
        });
        results.push(...transactions);
        total = transactions?.length;
        params.from = params.to + 1;
        params.to += constants.DEFAULT_LIMIT;
      } while (total === constants.DEFAULT_LIMIT);

      if (!results.length) {
        return;
      }

      if (max && results.length > max) {
        results = results.slice(-1 * max);
      }

      this._setLastId(+results[results.length - 1].id);

      results.forEach((item) => this.emitItem(item));
    },
    generateMeta(item) {
      return {
        id: item.id,
        summary: `New ${item.type} transaction`,
        ts: Date.parse(item.time),
      };
    },
  },
  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
OANDA	`oanda`	`app`	This component uses the OANDA app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Is Demo	`isDemo`	`boolean`	Set to `true` if using a demo/practice account
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`{ "value": "ORDER", "label": "Order-related Transactions. These are the Transactions that create, cancel, fill or trigger Orders" }{ "value": "FUNDING", "label": "Funding-related Transactions" }{ "value": "ADMIN", "label": "Administrative Transactions" }{ "value": "CREATE", "label": "Account Create Transaction" }{ "value": "CLOSE", "label": "Account Close Transaction" }{ "value": "REOPEN", "label": "Account Reopen Transaction" }{ "value": "CLIENT_CONFIGURE", "label": "Client Configuration Transaction" }{ "value": "CLIENT_CONFIGURE_REJECT", "label": "Client Configuration Reject Transaction" }{ "value": "TRANSFER_FUNDS", "label": "Transfer Funds Transaction" }{ "value": "TRANSFER_FUNDS_REJECT", "label": "Transfer Funds Reject Transaction" }{ "value": "MARKET_ORDER", "label": "Market Order Transaction" }{ "value": "MARKET_ORDER_REJECT", "label": "Market Order Reject Transaction" }{ "value": "LIMIT_ORDER", "label": "Limit Order Transaction" }{ "value": "LIMIT_ORDER_REJECT", "label": "Limit Order Reject Transaction" }{ "value": "STOP_ORDER", "label": "Stop Order Transaction" }{ "value": "STOP_ORDER_REJECT", "label": "Stop Order Reject Transaction" }{ "value": "MARKET_IF_TOUCHED_ORDER", "label": "Market if Touched Order Transaction" }{ "value": "MARKET_IF_TOUCHED_ORDER_REJECT", "label": "Market if Touched Order Reject Transaction" }{ "value": "TAKE_PROFIT_ORDER", "label": "Take Profit Order Transaction" }{ "value": "TAKE_PROFIT_ORDER_REJECT", "label": "Take Profit Order Reject Transaction" }{ "value": "STOP_LOSS_ORDER", "label": "Stop Loss Order Transaction" }{ "value": "STOP_LOSS_ORDER_REJECT", "label": "Stop Loss Order Reject Transaction" }{ "value": "GUARANTEED_STOP_LOSS_ORDER", "label": "Guaranteed Stop Loss Order Transaction" }{ "value": "GUARANTEED_STOP_LOSS_ORDER_REJECT", "label": "Guaranteed Stop Loss Order Reject Transaction" }{ "value": "TRAILING_STOP_LOSS_ORDER", "label": "Trailing Stop Loss Order Transaction" }{ "value": "TRAILING_STOP_LOSS_ORDER_REJECT", "label": "Trailing Stop Loss Order Reject Transaction" }{ "value": "ONE_CANCELS_ALL_ORDER", "label": "One Cancels All Order Transaction" }{ "value": "ONE_CANCELS_ALL_ORDER_REJECT", "label": "One Cancels All Order Reject Transaction" }{ "value": "ONE_CANCELS_ALL_ORDER_TRIGGERED", "label": "One Cancels All Order Trigger Transaction" }{ "value": "ORDER_FILL", "label": "Order Fill Transaction" }{ "value": "ORDER_CANCEL", "label": "Order Cancel Transaction" }{ "value": "ORDER_CANCEL_REJECT", "label": "Order Cancel Reject Transaction" }{ "value": "ORDER_CLIENT_EXTENSIONS_MODIFY", "label": "Order Client Extensions Modify Transaction" }{ "value": "ORDER_CLIENT_EXTENSIONS_MODIFY_REJECT", "label": "Order Client Extensions Modify Reject Transaction" }{ "value": "TRADE_CLIENT_EXTENSIONS_MODIFY", "label": "Trade Client Extensions Modify Transaction" }{ "value": "TRADE_CLIENT_EXTENSIONS_MODIFY_REJECT", "label": "Trade Client Extensions Modify Reject Transaction" }{ "value": "MARGIN_CALL_ENTER", "label": "Margin Call Enter Transaction" }{ "value": "MARGIN_CALL_EXTEND", "label": "Margin Call Extend Transaction" }{ "value": "MARGIN_CALL_EXIT", "label": "Margin Call Exit Transaction" }{ "value": "DELAYED_TRADE_CLOSURE", "label": "Delayed Trade Closure Transaction" }{ "value": "DAILY_FINANCING", "label": "Daily Financing Transaction" }{ "value": "RESET_RESETTABLE_PL", "label": "Reset Resettable PL Transaction" }`

Trigger Authentication#

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

About OANDA#

OANDA is a global leader in online multi-asset trading services, currency data, corporate payments and FX services.

Action#

Add Contact on UpViral

Description:Add a new contact in your particular campaign. [See the documentation](https://api.upviral.com/#add-contact)

Version:0.0.1

Key:upviral-add-contact

View on GitHub

UpViral Overview#

UpViral is a platform designed to create and run referral campaigns with ease. With the UpViral API, you can automate the collection of lead data, manage contests, and track the performance of your campaigns directly within Pipedream. This allows for a seamless integration of viral marketing efforts into your existing business processes. By leveraging the API, you can trigger actions in other apps based on campaign results, synchronize lead data with CRM systems, and even automate the distribution of rewards to contest winners.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import upviral from "../../upviral.app.mjs";

export default {
  key: "upviral-add-contact",
  name: "Add Contact",
  version: "0.0.1",
  description: "Add a new contact in your particular campaign. [See the documentation](https://api.upviral.com/#add-contact)",
  type: "action",
  props: {
    upviral,
    campaignId: {
      propDefinition: [
        upviral,
        "campaignId",
      ],
      reloadProps: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The user's email address.",
    },
    name: {
      type: "string",
      label: "Name",
      description: "The user's name.",
      optional: true,
    },
    ipAddress: {
      type: "string",
      label: "IP Address",
      description: "The user's IP Address.",
      optional: true,
    },
    referralCode: {
      type: "string",
      label: "Referral Code",
      description: "The unique referral code (Last part of unique Referral URL). For example - https://upvir.al/ref/XXXX, Referral Code will be XXXX.This will be the referral code of the person who referred this new contact. The original participant will get the credit for this new contact.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.campaignId) {
      let count = 0;
      let data = new FormData();
      data.append("campaign_id", this.campaignId);

      const { custom_fields: customFields } = await this.upviral.listCustomFields({
        data,
        headers: data.getHeaders(),
      });

      for (const field of customFields) {
        props[`customField-${field}`] = {
          type: "string",
          label: field,
          description: `Custom field ${++count}`,
          optional: true,
        };
      }
    }
    return props;
  },
  methods: {
    parseCustomFields() {
      const customFields = Object.entries(this).filter(([
        key,
      ]) => key.includes("customField-"))
        .map(([
          key,
          value,
        ]) => ([
          key.split("-")[1],
          value,
        ]));

      return JSON.stringify(Object.fromEntries(customFields)) || null;
    },
  },
  async run({ $ }) {
    var bodyFormData = new FormData();
    bodyFormData.append("campaign_id", this.campaignId);
    bodyFormData.append("email", this.email);
    if (this.name) bodyFormData.append("name", this.name);
    if (this.ipAddress) bodyFormData.append("ip_address", this.ipAddress);
    if (this.referralCode) bodyFormData.append("referral_code", this.referralCode);
    bodyFormData.append("custom_fields", this.parseCustomFields() );

    const response = await this.upviral.addContact({
      $,
      data: bodyFormData,
      headers: bodyFormData.getHeaders(),
    });

    if (response.result === "error") {
      throw new ConfigurationError(response.message);
    }

    $.export("$summary", `A new contact with UID: '${response.uid}' was successfully created!`);
    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
UpViral	`upviral`	`app`	This component uses the UpViral app.
Campaign Id	`campaignId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The user's email address.
Name	`name`	`string`	The user's name.
IP Address	`ipAddress`	`string`	The user's IP Address.
Referral Code	`referralCode`	`string`	The unique referral code (Last part of unique Referral URL). For example - https://upvir.al/ref/XXXX, Referral Code will be XXXX.This will be the referral code of the person who referred this new contact. The original participant will get the credit for this new contact.