Get Contents with Exa API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Get Contents with the Exa 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 Exa 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 Get Contents action
1. Connect your Exa account
2. Configure URLs
3. Optional- Configure Include Text
4. Optional- Configure Highlights Num Sentences
5. Optional- Configure Highlights Per URL
6. Optional- Configure Highlights Query
7. Optional- Configure Summary Query
8. Optional- Configure Summary Schema
9. Optional- Select a Live Crawl
10. Optional- Configure Live Crawl Timeout
11. Optional- Configure Subpages
12. Optional- Configure Subpage Target
13. Optional- Configure Extras Links
14. Optional- Configure Extras Image Links
15. Optional- Configure Include Context
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#

Get Contents on Exa

Description:Retrieves full page contents, summaries, and metadata for a list of URLs. Uses cached results with optional live crawling fallback. [See the documentation](https://docs.exa.ai/reference/get-contents)

Version:0.0.1

Key:exa-get-contents

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../exa.app.mjs";

export default {
  key: "exa-get-contents",
  name: "Get Contents",
  description: "Retrieves full page contents, summaries, and metadata for a list of URLs. Uses cached results with optional live crawling fallback. [See the documentation](https://docs.exa.ai/reference/get-contents)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    app,
    urls: {
      propDefinition: [
        app,
        "urls",
      ],
    },
    text: {
      description: "If `true`, returns full page text with default settings. If `false`, disables text return.",
      propDefinition: [
        app,
        "text",
      ],
    },
    highlightsNumSentences: {
      propDefinition: [
        app,
        "highlightsNumSentences",
      ],
    },
    highlightsPerUrl: {
      propDefinition: [
        app,
        "highlightsPerUrl",
      ],
    },
    highlightsQuery: {
      propDefinition: [
        app,
        "highlightsQuery",
      ],
    },
    summaryQuery: {
      propDefinition: [
        app,
        "summaryQuery",
      ],
    },
    summarySchema: {
      propDefinition: [
        app,
        "summarySchema",
      ],
    },
    livecrawl: {
      propDefinition: [
        app,
        "livecrawl",
      ],
    },
    livecrawlTimeout: {
      type: "integer",
      label: "Live Crawl Timeout",
      description: "Timeout in milliseconds for live crawling (default: 10000)",
      optional: true,
    },
    subpages: {
      propDefinition: [
        app,
        "subpages",
      ],
    },
    subpageTarget: {
      propDefinition: [
        app,
        "subpageTarget",
      ],
    },
    extrasLinks: {
      propDefinition: [
        app,
        "extrasLinks",
      ],
    },
    extrasImageLinks: {
      propDefinition: [
        app,
        "extrasImageLinks",
      ],
    },
    context: {
      description: "Return page contents as a context string for LLM. When true, combines all result contents into one string. We recommend using 10000+ characters for best results, though no limit works best. Context strings often perform better than highlights for RAG applications.",
      propDefinition: [
        app,
        "context",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      urls,
      text,
      highlightsNumSentences,
      highlightsPerUrl,
      highlightsQuery,
      summaryQuery,
      summarySchema,
      livecrawl,
      livecrawlTimeout,
      subpages,
      subpageTarget,
      extrasLinks,
      extrasImageLinks,
      context,
    } = this;

    let parsedSchema;
    if (summarySchema) {
      if (typeof summarySchema === "string") {
        try {
          parsedSchema = JSON.parse(summarySchema);
        } catch (error) {
          throw new ConfigurationError(`Invalid JSON schema format: ${error.message}. Please provide a valid JSON object.`);
        }
      } else {
        parsedSchema = summarySchema;
      }
    }

    const response = await app.getContents({
      $,
      data: {
        urls,
        text,
        livecrawl,
        livecrawlTimeout,
        subpages,
        subpageTarget,
        context,
        ...(extrasLinks
        || extrasImageLinks
          ? {
            extras: {
              links: extrasLinks,
              imageLinks: extrasImageLinks,
            },
          }
          : undefined
        ),
        ...(highlightsNumSentences
          || highlightsPerUrl
          || highlightsQuery
          ? {
            highlights: {
              numSentences: highlightsNumSentences,
              highlightsPerUrl,
              query: highlightsQuery,
            },
          }
          : undefined
        ),
        ...(summaryQuery
          || summarySchema
          ? {
            summary: {
              query: summaryQuery,
              schema: parsedSchema,
            },
          }
          : undefined
        ),
      },
    });

    $.export("$summary", `Successfully retrieved contents with ID \`${response.requestId}\`.`);
    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
Exa	`app`	`app`	This component uses the Exa app.
URLs	`urls`	`string[]`	List of URLs to retrieve contents for
Include Text	`text`	`boolean`	If `true`, returns full page text with default settings. If `false`, disables text return.
Highlights Num Sentences	`highlightsNumSentences`	`integer`	The number of sentences to return for each snippet.
Highlights Per URL	`highlightsPerUrl`	`integer`	The number of snippets to return for each result.
Highlights Query	`highlightsQuery`	`string`	Custom query to direct the LLM's selection of highlights.
Summary Query	`summaryQuery`	`string`	Custom query to guide summary generation
Summary Schema	`summarySchema`	`object`	JSON schema for structured output from summary. See JSON Schema documentation for details. Example: `{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Title", "type": "object", "properties": { "Property 1": { "type": "string", "description": "Description" }, "Property 2": { "type": "string", "enum": ["option 1", "option 2", "option 3"], "description": "Description" } }, "required": ["Property 1"] }`
Live Crawl	`livecrawl`	`string`	Select a value from the drop down menu:`neverfallbackalwayspreferred`
Live Crawl Timeout	`livecrawlTimeout`	`integer`	Timeout in milliseconds for live crawling (default: 10000)
Subpages	`subpages`	`integer`	Number of subpages to crawl per result
Subpage Target	`subpageTarget`	`string`	Keywords to identify specific subpages to crawl
Extras Links	`extrasLinks`	`integer`	Number of URLs to return from each webpage.
Extras Image Links	`extrasImageLinks`	`integer`	Number of images to return for each result.
Include Context	`context`	`boolean`	Return page contents as a context string for LLM. When true, combines all result contents into one string. We recommend using 10000+ characters for best results, though no limit works best. Context strings often perform better than highlights for RAG applications.