Launch Phantom with Phantombuster API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Launch Phantom with the Phantombuster 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 Phantombuster 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 Launch Phantom action
1. Connect your Phantombuster account
2. Select a Agent ID
3. Optional- Configure Arguments
4. Optional- Configure Save Arguments
5. Optional- Configure Bonus Argument
6. Optional- Configure Manual Launch
7. Optional- Configure Max Instance Count
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#

Launch Phantom on Phantombuster

Description:Adds an agent to the launch queue, [See the docs](https://hub.phantombuster.com/reference/post_agents-launch-1)

Version:0.0.1

Key:phantombuster-launch-phantom

View on GitHub

Phantombuster Overview#

Phantombuster is a powerful API that enables users to build efficient web
automation solutions. It provides a pool of services and tools to help users
quickly, easily and securely interact with multiple websites at once.

With Phantombuster, users can create custom automated solutions to perform
various tasks such as data extraction, lead generation, marketing automation,
and web scraping. Here are a few of the things users can build using
Phantombuster:

Data extraction - Phantombuster's API allows users to quickly and securely
extract data from multiple sites and APIs, allowing users to access large
amounts of data at once and extract only what they need.
Lead generation - Phantombuster's API connects to multiple social networks
and websites, allowing users to quickly and accurately gather leads or
potential contacts and store them into a database.
Automated marketing campaigns - Phantombuster's API enables users to create
and launch automated marketing campaigns, automating the entire process and
saving time and money.
Web scraping - Phantombuster's API allows users to scrape entire webpages or
just parts of it, enabling streamlined data years.
Robot monitoring - Phantombuster's API enables users to monitor robots,
allowing them to keep an eye on their tasks and ensuring their bots are
running as efficiently as possible.
Data analytics - Phantombuster's API allows users to easily analyze and
visualize their gathered data, allowing them to quickly make decisions based
on their collected data.

Action Code#

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

export default {
  type: "action",
  key: "phantombuster-launch-phantom",
  version: "0.0.1",
  name: "Launch Phantom",
  description: "Adds an agent to the launch queue, [See the docs](https://hub.phantombuster.com/reference/post_agents-launch-1)",
  props: {
    app,
    agentId: {
      propDefinition: [
        app,
        "agentId",
      ],
    },
    arguments: {
      type: "string",
      label: "Arguments",
      description: "Agent arguments. Must be a JSON string, e.g. `{\"key1\": \"Value 1\", \"key2\": \"Value 2\"}`",
      optional: true,
    },
    saveArguments: {
      type: "boolean",
      label: "Save Arguments",
      description: "If true, argument will be saved as the default launch options for the agent.",
      optional: true,
    },
    bonusArgument: {
      type: "string",
      label: "Bonus Argument",
      description: "Agent bonus argument. This bonus argument is single-use, it will only be used for the current launch. Must be a JSON string, e.g. `{\"key1\": \"Value 1\", \"key2\": \"Value 2\"}`",
      optional: true,
    },
    manualLaunch: {
      type: "boolean",
      label: "Manual Launch",
      description: "If set, the agent will be considered as `launched manually`.",
      optional: true,
    },
    maxInstanceCount: {
      type: "integer",
      label: "Max Instance Count",
      description: "If set, the agent will only be launched if the number of already running instances is below the specified number.",
      optional: true,
    },
  },
  async run ({ $ }) {
    const resp = await this.app.launchPhantom({
      $,
      data: {
        id: this.agentId,
        arguments: this.arguments,
        saveArguments: this.saveArguments,
        bonusArgument: this.bonusArgument,
        manualLaunch: this.manualLaunch,
        maxInstanceCount: this.maxInstanceCount,
      },
    });
    $.export("$summary", `Phantom has been launched succesfully. Container ID(${resp.containerId})`);
    return resp;
  },
};

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
Phantombuster	`app`	`app`	This component uses the Phantombuster app.
Agent ID	`agentId`	`string`	Select a value from the drop down menu.
Arguments	`arguments`	`string`	Agent arguments. Must be a JSON string, e.g. `{"key1": "Value 1", "key2": "Value 2"}`
Save Arguments	`saveArguments`	`boolean`	If true, argument will be saved as the default launch options for the agent.
Bonus Argument	`bonusArgument`	`string`	Agent bonus argument. This bonus argument is single-use, it will only be used for the current launch. Must be a JSON string, e.g. `{"key1": "Value 1", "key2": "Value 2"}`
Manual Launch	`manualLaunch`	`boolean`	If set, the agent will be considered as `launched manually`.
Max Instance Count	`maxInstanceCount`	`integer`	If set, the agent will only be launched if the number of already running instances is below the specified number.

Action Authentication#

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

Your API key resides in your Phantombuster Org settings page. This page is also accessible through your navbar's menu, under the label "Org settings". Please notice that for security reasons, you key will only be shown once, on creation. You better copy it in a safe place before refreshing or leaving the page.

For more info, refer to Phantombuster's API documentation.