Scrape with JS Rendering with ScrapeNinja API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Scrape with JS Rendering with the ScrapeNinja 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 ScrapeNinja 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 Scrape with JS Rendering action
1. Connect your ScrapeNinja account
2. Configure URL
3. Optional- Configure Wait For Selector
4. Optional- Configure Post Wait Time
5. Optional- Configure Dump Iframe
6. Optional- Configure Wait For Selector Iframe
7. Optional- Configure Extractor Target Iframe
8. Optional- Configure Headers
9. Optional- Configure Retry Number
10. Optional- Configure Geo
11. Optional- Configure Proxy
12. Optional- Configure Timeout
13. Optional- Configure Text Not Expected
14. Optional- Configure Status Not Expected
15. Optional- Configure Block Images
16. Optional- Configure Block Media
17. Optional- Configure Screenshot
18. Optional- Configure Catch Ajax Headers URL Mask
19. Optional- Configure Viewport Width
20. Optional- Configure Viewport Height
21. Optional- Configure Viewport Device Scale Factor
22. Optional- Configure Viewport Has Touch
23. Optional- Configure Viewport Is Mobile
24. Optional- Configure Viewport Is Landscape
25. Optional- Configure Extractor
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#

Scrape with JS Rendering on ScrapeNinja

Description:Uses the ScrapeNinja real Chrome browser engine to scrape pages that require JS rendering. [See the documentation](https://scrapeninja.net/docs/api-reference/scrape-js/)

Version:0.0.1

Key:scrapeninja-scrape-with-js-rendering

View on GitHub

ScrapeNinja Overview#

ScrapeNinja API on Pipedream allows you to craft powerful serverless workflows for web scraping without the hassle of managing proxies or browsers. It's a tool that can extract data from websites, handling JavaScript rendering and anti-bot measures with ease. By integrating ScrapeNinja with Pipedream, you can automate data collection, collate and process the scraped data, and connect it to numerous other services for further analysis, alerting, or storage.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  clearObj,
  parseError, parseObject,
} from "../../common/utils.mjs";
import scrapeninja from "../../scrapeninja.app.mjs";

export default {
  key: "scrapeninja-scrape-with-js-rendering",
  name: "Scrape with JS Rendering",
  description: "Uses the ScrapeNinja real Chrome browser engine to scrape pages that require JS rendering. [See the documentation](https://scrapeninja.net/docs/api-reference/scrape-js/)",
  version: "0.0.1",
  type: "action",
  props: {
    scrapeninja,
    url: {
      propDefinition: [
        scrapeninja,
        "url",
      ],
    },
    waitForSelector: {
      propDefinition: [
        scrapeninja,
        "waitForSelector",
      ],
      optional: true,
    },
    postWaitTime: {
      propDefinition: [
        scrapeninja,
        "postWaitTime",
      ],
      optional: true,
    },
    dumpIframe: {
      propDefinition: [
        scrapeninja,
        "dumpIframe",
      ],
      optional: true,
    },
    waitForSelectorIframe: {
      propDefinition: [
        scrapeninja,
        "waitForSelectorIframe",
      ],
      optional: true,
    },
    extractorTargetIframe: {
      propDefinition: [
        scrapeninja,
        "extractorTargetIframe",
      ],
      optional: true,
    },
    headers: {
      propDefinition: [
        scrapeninja,
        "headers",
      ],
      optional: true,
    },
    retryNum: {
      propDefinition: [
        scrapeninja,
        "retryNum",
      ],
      optional: true,
    },
    geo: {
      propDefinition: [
        scrapeninja,
        "geo",
      ],
      optional: true,
    },
    proxy: {
      propDefinition: [
        scrapeninja,
        "proxy",
      ],
      optional: true,
    },
    timeout: {
      propDefinition: [
        scrapeninja,
        "timeout",
      ],
      optional: true,
    },
    textNotExpected: {
      propDefinition: [
        scrapeninja,
        "textNotExpected",
      ],
      optional: true,
    },
    statusNotExpected: {
      propDefinition: [
        scrapeninja,
        "statusNotExpected",
      ],
      optional: true,
    },
    blockImages: {
      propDefinition: [
        scrapeninja,
        "blockImages",
      ],
      optional: true,
    },
    blockMedia: {
      propDefinition: [
        scrapeninja,
        "blockMedia",
      ],
      optional: true,
    },
    screenshot: {
      propDefinition: [
        scrapeninja,
        "screenshot",
      ],
      optional: true,
    },
    catchAjaxHeadersUrlMask: {
      propDefinition: [
        scrapeninja,
        "catchAjaxHeadersUrlMask",
      ],
      optional: true,
    },
    viewportWidth: {
      propDefinition: [
        scrapeninja,
        "viewportWidth",
      ],
      optional: true,
    },
    viewportHeight: {
      propDefinition: [
        scrapeninja,
        "viewportHeight",
      ],
      optional: true,
    },
    viewportDeviceScaleFactor: {
      propDefinition: [
        scrapeninja,
        "viewportDeviceScaleFactor",
      ],
      optional: true,
    },
    viewportHasTouch: {
      propDefinition: [
        scrapeninja,
        "viewportHasTouch",
      ],
      optional: true,
    },
    viewportIsMobile: {
      propDefinition: [
        scrapeninja,
        "viewportIsMobile",
      ],
      optional: true,
    },
    viewportIsLandscape: {
      propDefinition: [
        scrapeninja,
        "viewportIsLandscape",
      ],
      optional: true,
    },
    extractor: {
      propDefinition: [
        scrapeninja,
        "extractor",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const viewport = clearObj({
        width: this.viewportWidth,
        height: this.viewportHeight,
        deviceScaleFactor: this.viewportDeviceScaleFactor,
        hasTouch: this.viewportHasTouch,
        isMobile: this.viewportIsMobile,
        isLandscape: this.viewportIsLandscape,
      });

      const data = clearObj({
        url: this.url,
        waitForSelector: this.waitForSelector,
        postWaitTime: this.postWaitTime,
        dumpIframe: this.dumpIframe,
        waitForSelectorIframe: this.waitForSelectorIframe,
        extractorTargetIframe: this.extractorTargetIframe,
        headers: parseObject(this.headers),
        retryNum: this.retryNum,
        geo: this.geo,
        proxy: this.proxy,
        timeout: this.timeout,
        textNotExpected: parseObject(this.textNotExpected),
        statusNotExpected: parseObject(this.statusNotExpected),
        blockImages: this.blockImages,
        blockMedia: this.blockMedia,
        screenshot: this.screenshot,
        catchAjaxHeadersUrlMask: this.catchAjaxHeadersUrlMask,
        extractor: this.extractor,
      });

      if (Object.entries(viewport).length) {
        data.viewport = viewport;
      }

      const response = await this.scrapeninja.scrapeJs({
        $,
        data,
      });

      $.export("$summary", `Successfully scraped ${this.url} with JS rendering`);
      return response;
    } catch ({ response: { data } }) {
      throw new ConfigurationError(parseError(data));
    }
  },
};

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
ScrapeNinja	`scrapeninja`	`app`	This component uses the ScrapeNinja app.
URL	`url`	`string`	The URL to scrape.
Wait For Selector	`waitForSelector`	`string`	CSS selector to wait for before considering the page loaded.
Post Wait Time	`postWaitTime`	`integer`	Wait for specified amount of seconds after page load (from 1 to 12s). Use this only if ScrapeNinja failed to wait for required page elements automatically.
Dump Iframe	`dumpIframe`	`string`	If some particular iframe needs to be dumped, specify its name HTML value in this argument. The ScrapeNinja JS renderer will wait for CSS selector to wait for iframe DOM elements to appear inside.
Wait For Selector Iframe	`waitForSelectorIframe`	`string`	If `Dump Iframe` is activated, this property allows to wait for CSS selector inside this iframe.
Extractor Target Iframe	`extractorTargetIframe`	`boolean`	If `Dump Iframe` is activated, this property allows to run JS extractor function against iframe HTML instead of running it against base body. This is only useful if `Dump Iframe` is activated.
Headers	`headers`	`string[]`	Custom headers to send with the request. By default, regular Chrome browser headers are sent to the target URL.
Retry Number	`retryNum`	`integer`	Amount of attempts.
Geo	`geo`	`string`	Geo location for basic proxy pools (you can purchase premium ScrapeNinja proxies for wider country selection and higher proxy quality). Read more about ScrapeNinja proxy setup
Proxy	`proxy`	`string`	Premium or your own proxy URL (overrides `Geo` prop). Read more about ScrapeNinja proxy setup
Timeout	`timeout`	`integer`	Timeout per attempt, in seconds. Each retry will take [timeout] number of seconds.
Text Not Expected	`textNotExpected`	`string[]`	Text which will trigger a retry from another proxy address.
Status Not Expected	`statusNotExpected`	`integer[]`	HTTP response statuses which will trigger a retry from another proxy address.
Block Images	`blockImages`	`boolean`	Block images from loading. This will speed up page loading and reduce bandwidth usage.
Block Media	`blockMedia`	`boolean`	Block (CSS, fonts) from loading. This will speed up page loading and reduce bandwidth usage.
Screenshot	`screenshot`	`boolean`	Take a screenshot of the page. Pass "false" to increase the speed of the request.
Catch Ajax Headers URL Mask	`catchAjaxHeadersUrlMask`	`string`	Useful to dump some XHR response. Pass URL mask here. For example, if you need to catch all requests to https://example.com/api/data.json, pass "api/data.json" here. In response, you will get new property `.info.catchedAjax` with the XHR response data - { url, method, headers[], body , status, responseHeaders{} }
Viewport Width	`viewportWidth`	`integer`	Width of the viewport.
Viewport Height	`viewportHeight`	`integer`	Height of the viewport.
Viewport Device Scale Factor	`viewportDeviceScaleFactor`	`integer`	Device scale factor for the viewport.
Viewport Has Touch	`viewportHasTouch`	`boolean`	Whether the viewport has touch capabilities.
Viewport Is Mobile	`viewportIsMobile`	`boolean`	Whether the viewport is mobile.
Viewport Is Landscape	`viewportIsLandscape`	`boolean`	Whether the viewport is in landscape mode.
Extractor	`extractor`	`string`	Custom JS function to extract JSON values from scraped HTML. Write&test your own extractor on https://scrapeninja.net/cheerio-sandbox/

Action Authentication#

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

Using ScrapingNinja in Pipedream

Create a RapidAPI Account: Begin by signing up for a RapidAPI account.
Access Your API Key:
- Once registered, you'll be able to interact with ScrapingNinja using your RapidAPI key.
- Open the ScrapingNinja documentation on RapidAPI and locate your API key labeled X-RapidAPI-Key.
- Copy this key and paste it into the rapid_api_key field below.
Subscribe to the API: Finally, click Subscribe to Test in the RapidAPI console to subscribe to the ScrapingNinja API.