Validate Emails in File with ZeroBounce API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for ZeroBounce, Typeform and 2,900+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Validate Emails in File with the ZeroBounce 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 Typeform trigger and ZeroBounce 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 Validate Emails in File action
1. Connect your ZeroBounce account
2. Configure File Path or URL
3. Configure Email Address Column
4. Optional- Configure First Name Column
5. Optional- Configure Last Name Column
6. Optional- Configure IP Address Column
7. Optional- Configure Has Header Row
8. Optional- Configure Remove Duplicates
9. Optional- Configure Return URL
10. Optional- Configure Callback With Rerun
11. Optional- Configure syncDir
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#

Validate Emails in File on ZeroBounce

Description:Performs email validation on all the addresses contained in a provided file. [See the documentation](https://www.zerobounce.net/docs/email-validation-api-quickstart/)

Version:0.1.3

Key:zerobounce-file-validation

View on GitHub

ZeroBounce Overview#

The ZeroBounce API provides email verification services that help improve email deliverability by removing invalid or risky email addresses from your lists. When integrated with Pipedream, you can automate workflows to clean your mailing lists, validate subscribers in real-time, and enrich your contacts. Pipedream's serverless platform facilitates the running of code that interacts with the ZeroBounce API to execute these tasks based on various triggers and actions from other integrated services.

Action Code#

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

export default {
  key: "zerobounce-file-validation",
  name: "Validate Emails in File",
  description: "Performs email validation on all the addresses contained in a provided file. [See the documentation](https://www.zerobounce.net/docs/email-validation-api-quickstart/)",
  version: "0.1.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    zerobounce,
    filePath: {
      type: "string",
      label: "File Path or URL",
      description: "The csv or txt file to validate. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.csv`)",
    },
    emailAddressColumn: {
      type: "integer",
      label: "Email Address Column",
      description: "The column index of the email address in the file. Index starts from 1.",
    },
    firstNameColumn: {
      type: "integer",
      label: "First Name Column",
      description: "The column index of the first name column. Index starts from 1.",
      optional: true,
    },
    lastNameColumn: {
      type: "integer",
      label: "Last Name Column",
      description: "The column index of the last name column. Index starts from 1.",
      optional: true,
    },
    ipAddressColumn: {
      type: "integer",
      label: "IP Address Column",
      description: "The IP Address the email signed up from. Index starts from 1",
      optional: true,
    },
    hasHeaderRow: {
      type: "boolean",
      label: "Has Header Row",
      description: "If the first row from the submitted file is a header row",
      optional: true,
    },
    removeDuplicates: {
      type: "boolean",
      label: "Remove Duplicates",
      description: "If you want the system to remove duplicate emails. Default is `true`. Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified.",
      optional: true,
    },
    returnUrl: {
      type: "string",
      label: "Return URL",
      description: "The URL will be used to call back when the validation is completed",
      optional: true,
    },
    callbackWithRerun: {
      type: "boolean",
      label: "Callback With Rerun",
      description: "Use the `$.flow.rerun` Node.js helper to rerun the step when the validation is completed. Overrides the `rerunUrl` prop. This will increase execution time and credit usage as a result. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun/#flow-rerun). Not available in Pipedream Connect.",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    let response, summary;
    const context = $.context;
    const run = context
      ? context.run
      : {
        runs: 1,
      };

    if (run.runs === 1) {
      let returnUrl  = this.returnUrl;
      if (context && this.callbackWithRerun) {
        ({ resume_url: returnUrl } = $.flow.rerun(600000, null, 1));
      }

      const {
        stream, metadata,
      } = await getFileStreamAndMetadata(this.filePath);
      const formData = new FormData();
      formData.append("file", stream, {
        contentType: metadata.contentType,
        knownLength: metadata.size,
        filename: metadata.name,
      });
      formData.append("email_address_column", this.emailAddressColumn);
      formData.append("api_key", this.zerobounce.$auth.api_key);
      if (this.firstNameColumn) {
        formData.append("first_name_column", this.firstNameColumn);
      }
      if (this.lastNameColumn) {
        formData.append("last_name_column", this.lastNameColumn);
      }
      if (this.ipAddressColumn) {
        formData.append("ip_address_column", this.ipAddressColumn);
      }
      if (this.hasHeaderRow) {
        formData.append("has_header_row", this.hasHeaderRow
          ? "true"
          : "false");
      }
      if (this.removeDuplicates) {
        formData.append("remove_duplicate", this.removeDuplicates
          ? "true"
          : "false");
      }
      if (returnUrl) {
        formData.append("return_url", returnUrl);
      }

      response = await this.zerobounce.validateEmailsInFile({
        $,
        data: formData,
        headers: {
          ...formData.getHeaders(),
        },
      });
      summary = "Successfully sent file for validation";
    }

    if (run.callback_request) {
      response = run.callback_request.body;
      summary = "Successfully validated emails in file";
    }

    $.export("$summary", summary);
    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
ZeroBounce	`zerobounce`	`app`	This component uses the ZeroBounce app.
File Path or URL	`filePath`	`string`	The csv or txt file to validate. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.csv`)
Email Address Column	`emailAddressColumn`	`integer`	The column index of the email address in the file. Index starts from 1.
First Name Column	`firstNameColumn`	`integer`	The column index of the first name column. Index starts from 1.
Last Name Column	`lastNameColumn`	`integer`	The column index of the last name column. Index starts from 1.
IP Address Column	`ipAddressColumn`	`integer`	The IP Address the email signed up from. Index starts from 1
Has Header Row	`hasHeaderRow`	`boolean`	If the first row from the submitted file is a header row
Remove Duplicates	`removeDuplicates`	`boolean`	If you want the system to remove duplicate emails. Default is `true`. Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified.
Return URL	`returnUrl`	`string`	The URL will be used to call back when the validation is completed
Callback With Rerun	`callbackWithRerun`	`boolean`	Use the `$.flow.rerun` Node.js helper to rerun the step when the validation is completed. Overrides the `rerunUrl` prop. This will increase execution time and credit usage as a result. See the documentation. Not available in Pipedream Connect.
syncDir	`syncDir`	`dir`

Action Authentication#

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

To retrieve your API keys,