Send New SMS with Octopush SMS API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Send New SMS with the Octopush SMS API

No credit card required

▶

Watch us build a workflow

8 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 Typeform trigger and Octopush SMS action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Send New SMS action
1. Connect your Octopush SMS account
2. Configure Text
3. Configure Phone Number
4. Configure First Name
5. Configure Last Name
6. Select a Type
7. Optional- Configure Sender
8. Optional- Configure Send At
9. Optional- Select a Purpose
10. Optional- Configure With Replies
11. Optional- Configure Simulation Mode
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Send New SMS on Octopush SMS

Description:Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)

Version:0.0.1

Key:octopush_sms-send-new-sms

View on GitHub

Octopush SMS Overview#

The Octopush SMS API lets you programmatically send text messages, providing a powerful way to reach out to customers directly on their phones. With Pipedream, you can create workflows that trigger SMS sending via Octopush based on various events, streamlining communication processes. You could use this API to send alerts, reminders, verification codes, or marketing messages, and integrate with other apps to respond to emails, form submissions, or updates in a CRM.

Action Code#

import octopush from "../../octopush_sms.app.mjs";

export default {
  key: "octopush_sms-send-new-sms",
  name: "Send New SMS",
  description: "Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)",
  version: "0.0.1",
  type: "action",
  props: {
    octopush,
    text: {
      type: "string",
      label: "Text",
      description: "The message text (from 1 to 1224 characters).",
    },
    phone: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the recipient",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the recipient",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the recipient",
    },
    type: {
      type: "string",
      label: "Type",
      description: "Campaign Type",
      options: [
        "sms_premium",
        "sms_low_cost",
      ],
    },
    sender: {
      type: "string",
      label: "Sender",
      description: "Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)",
      optional: true,
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)",
      optional: true,
    },
    purpose: {
      type: "string",
      label: "Purpose",
      description: "Campaign purpose",
      options: [
        "alert",
        "wholesale",
      ],
      optional: true,
    },
    withReplies: {
      type: "boolean",
      label: "With Replies",
      description: "Set to `true` to get back recipient replies",
      optional: true,
    },
    simulationMode: {
      type: "boolean",
      label: "Simulation Mode",
      description: "If this value is `true`, your request will be simulated, and you will receive a fake result",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.octopush.sendSMS({
      $,
      data: {
        text: this.text,
        recipients: [
          {
            phone_number: this.phone,
            first_name: this.firstName,
            last_name: this.lastName,
          },
        ],
        type: this.type,
        send_at: this.sendAt,
        purpose: this.purpose,
        with_replies: this.withReplies,
        simulation_mode: this.simulationMode,
      },
    });
    $.export("$summary", "Successfully send new SMS.");
    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
Octopush SMS	`octopush`	`app`	This component uses the Octopush SMS app.
Text	`text`	`string`	The message text (from 1 to 1224 characters).
Phone Number	`phone`	`string`	Phone number of the recipient
First Name	`firstName`	`string`	First name of the recipient
Last Name	`lastName`	`string`	Last name of the recipient
Type	`type`	`string`	Select a value from the drop down menu:`sms_premiumsms_low_cost`
Sender	`sender`	`string`	Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)
Send At	`sendAt`	`string`	When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)
Purpose	`purpose`	`string`	Select a value from the drop down menu:`alertwholesale`
With Replies	`withReplies`	`boolean`	Set to `true` to get back recipient replies
Simulation Mode	`simulationMode`	`boolean`	If this value is `true`, your request will be simulated, and you will receive a fake result