Send SMS with Textlocal API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Textlocal, Typeform and 1200+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Send SMS with the Textlocal API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Typeform trigger and Textlocal 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 SMS action
1. Connect your Textlocal account
2. Configure Sender
3. Configure Message
4. Optional- Configure Numbers
5. Optional- Select a Group Id
6. Optional- Configure Simple Reply
7. Optional- Configure Schedule Time
8. Optional- Configure Receipt URL
9. Optional- Configure Custom
10. Optional- Configure Optouts
11. Optional- Configure Validity
12. Optional- Configure Unicode
13. Optional- Configure Tracking Links
14. Configure Test
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.7

Key:typeform-new-submission

View on GitHub

Typeform Overview#

With the Typeform API, you can easily create beautiful, interactive forms that
allow people to share their information with you in an engaging way. Here are
some examples of what you can build with the Typeform API:

A contact form for your website that allows people to easily get in touch
with you
An order form for your product or service that allows people to place orders
easily and securely
A survey form that allows you to collect data and feedback from people
A registration form for your event or conference that allows people to sign
up easily and securely

Trigger Code#

import { createHmac } from "crypto";
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.7",
  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,
    });
  },
};

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#

People-Friendly Forms and Surveys

Action#

Send SMS on Textlocal

Description:This Action can be used to send text messages to either individual numbers or entire contact groups. [See the docs here](https://api.txtlocal.com/docs/sendsms) Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.

Version:0.0.1

Key:textlocal-send-sms

View on GitHub

Textlocal Overview#

You can do so much with the Textlocal API! Textlocal is an easy-to-use platform
for sending and receiving mobile and SMS messages, making it a great avenue for
businesses to communicate with their customers. Here are a few examples of what
you can build with the Textlocal API:

Automate SMS marketing campaigns to customers
Notify customers of special offers and discounts
Send reminders and appointment confirmations
Create location-based notifications
Receive two-way communication from customers
Integrate text alerts into other applications, like business workflows and
CRMs
Send mass notifications during emergencies

Action Code#

import textlocal from "../../textlocal.app.mjs";

export default {
  key: "textlocal-send-sms",
  name: "Send SMS",
  description:
    `This Action can be used to send text messages to either individual numbers or entire contact groups. [See the docs here](https://api.txtlocal.com/docs/sendsms)
    Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.`,
  version: "0.0.1",
  type: "action",
  props: {
    textlocal,
    sender: {
      propDefinition: [
        textlocal,
        "sender",
      ],
    },
    message: {
      propDefinition: [
        textlocal,
        "message",
      ],
    },
    numbers: {
      propDefinition: [
        textlocal,
        "numbers",
      ],
      description: "Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.",
      optional: true,
    },
    groupId: {
      propDefinition: [
        textlocal,
        "groupId",
      ],
      description: "Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.",
      optional: true,
    },
    simpleReply: {
      propDefinition: [
        textlocal,
        "simpleReply",
      ],
      optional: true,
    },
    scheduleTime: {
      propDefinition: [
        textlocal,
        "scheduleTime",
      ],
      optional: true,
    },
    receiptUrl: {
      propDefinition: [
        textlocal,
        "receiptUrl",
      ],
      optional: true,
    },
    custom: {
      propDefinition: [
        textlocal,
        "custom",
      ],
      optional: true,
    },
    optouts: {
      propDefinition: [
        textlocal,
        "optouts",
      ],
      optional: true,
    },
    validity: {
      propDefinition: [
        textlocal,
        "validity",
      ],
      optional: true,
    },
    unicode: {
      propDefinition: [
        textlocal,
        "unicode",
      ],
      optional: true,
    },
    trackingLinks: {
      propDefinition: [
        textlocal,
        "trackingLinks",
      ],
      optional: true,
    },
    test: {
      propDefinition: [
        textlocal,
        "test",
      ],
    },
  },
  async run({ $ }) {
    const params = {
      numbers: this.numbers,
      sender: this.sender,
      message: this.message,
      groupId: this.groupId,
      simple_reply: this.simpleReply,
      schedule_time: this.scheduleTime,
      receipt_url: this.receiptUrl,
      custom: this.custom,
      optouts: this.optouts,
      validity: this.validity,
      unicode: this.unicode,
      tracking_links: this.trackingLinks,
      test: this.test,
    };
    const response = await this.textlocal.sendSMS({
      $,
      params,
    });
    $.export("$summary", "Successfully sent 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
Textlocal	`textlocal`	`app`	This component uses the Textlocal app.
Sender	`sender`	`string`	Use this field to specify the sender name for your message. This must be at least 3 characters in length but no longer than 11 alphanumeric characters or 13 numeric characters. If this is excluded it will use the default sender name configured on your account
Message	`message`	`string`	The message content. This parameter should be no longer than 765 characters. See Helpful Information for message length details. The message also must be URL Encoded to support symbols like &.
Numbers	`numbers`	`string`	Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.
Group Id	`groupId`	`integer`	Select a value from the drop down menu.
Simple Reply	`simpleReply`	`boolean`	Set to true to enable the Simple Reply Service for the message. This will override any sender value, as a Simple Reply Service number will be used instead.
Schedule Time	`scheduleTime`	`string`	This parameter can be used to specify a schedule date/time for your message, which should be provided in Unix timestamp format. Times should be provided in GMT.
Receipt URL	`receiptUrl`	`string`	Use this field to specify an alternative URL to which the delivery receipt(s) will be sent. See handling receipts documentation.
Custom	`custom`	`string`	This value will be set against the message batch and will passed back in the delivery receipts. This allows you to match delivery receipts to their corresponding messages.
Optouts	`optouts`	`boolean`	Can be set to true in order to check against your own opt-outs list and Textlocal's global opt-outs database. Your message will not be sent to numbers within these lists. If not provided defaults to false.
Validity	`validity`	`string`	Can be set, up to 72 hours in advance, to say after which time, you don't want the message delivered. This should be in a Unix timestamp format.
Unicode	`unicode`	`boolean`	Set this value to true to specify that your message body will contain unicode characters. See Encoding/Decoding Unicode Documentation
Tracking Links	`trackingLinks`	`boolean`	Set this value to true to specify that the message contains links and they should be converted to short links (trackable in messenger), Please note that links must be url encoded before being placed into the message
Test	`test`	`boolean`	Set this field to true to enable test mode, no messages will be sent and your credit balance will be unaffected. If not provided defaults to false