Add Contact with UpViral API on New Incoming SMS (Instant) from Twilio API

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

Trigger workflow on

New Incoming SMS (Instant) from the Twilio 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 Twilio 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 Incoming SMS (Instant) trigger
1. Connect your Twilio account
2. Select a Incoming Phone Number
3. Optional- Configure Response Message
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 Incoming SMS (Instant) on Twilio

Description:Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.

Version:0.1.4

Key:twilio-new-incoming-sms

View on GitHub

Twilio Overview#

Twilio's API on Pipedream opens up a multitude of communication capabilities, allowing you to build robust, scalable, and automated workflows. With Twilio, you can send and receive SMS and MMS messages, make voice calls, and perform other communication functions programmatically. Leveraging Pipedream's seamless integration, you can connect these communications features with hundreds of other services to automate notifications, streamline customer interactions, and enhance operational efficiency.

Trigger Code#

import twilio from "twilio";
import common from "../common/common-webhook.mjs";
import constants from "../../common/constants.mjs";

const MessagingResponse = twilio.twiml.MessagingResponse;

export default {
  ...common,
  key: "twilio-new-incoming-sms",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.",
  version: "0.1.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    responseMessage: {
      propDefinition: [
        common.props.twilio,
        "responseMessage",
      ],
    },
  },
  methods: {
    ...common.methods,
    getServiceType() {
      return constants.SERVICE_TYPE.SMS;
    },
    getResponseBody() {
      const twiml = new MessagingResponse();
      let responseBody = "<Response></Response>";
      if (this.responseMessage) {
        twiml.message(this.responseMessage);
        responseBody = twiml.toString();
      }
      return responseBody;
    },
    generateMeta(body, headers) {
      return {
        /** if Twilio retries a message, but we've already emitted, dedupe */
        id: headers["i-twilio-idempotency-token"],
        summary: body.Body,
        ts: Date.now(),
      };
    },
  },
};

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
Twilio	`twilio`	`app`	This component uses the Twilio app.
Incoming Phone Number	`incomingPhoneNumber`	`string`	Select a value from the drop down menu.
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.
Response Message	`responseMessage`	`string`	The message you want to send in response to incoming messages. Leave this blank if you don't need to issue a response.

Trigger Authentication#

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

To connect your Twilio account to Pipedream,

API Key and API Key SID

First, create an API key in Twilio.

There are three types of keys: Main, Standard, and Restricted. You'll need a Main key to interact with certain API endpoints, like /Accounts.
If you don't need to interact with those endpoints, you can use a Standard or Restricted key.

After creating your key, you'll see fields for Sid and Secret. Enter those in the fields below.

Account SID and Auth Token

Visit your Twilio Dashboard. You'll see your Account SID and Auth Token under Account info.

About Twilio#

Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.

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.

Action Authentication#

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

To get your UpViral API Key, go to your Profile, then click the "API Key" tab.

About UpViral#

UpViral is the Ultimate Viral Referral Platform. It allows you to run viral campaigns - such as contests, giveaways and more.

More Ways to Connect UpViral + Twilio#

Other Popular Integrations#

Add Contact with UpViral API on New Call (Instant) from Twilio API

Twilio + UpViral