Get Contents of Documents with Exa (Formerly Metaphor) API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Exa (Formerly Metaphor), Typeform and 2,000+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Get Contents of Documents with the Exa (Formerly Metaphor) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Typeform trigger and Exa (Formerly Metaphor) 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 of Documents action
1. Connect your Exa (Formerly Metaphor) account
2. Optional- Configure Ids
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 of Documents on Exa (Formerly Metaphor)

Description:Retrieve contents of documents based on a list of document IDs. [See the documentation](https://docs.metaphor.systems/reference/contents). It is used to `instantly` get content for documents, given the IDs of the documents. We currently support extracts - the first 1000 tokens (~750 words) of parsed HTML for a site. **Note that each piece of content retrieved costs 1 request.** Also note that `instant` is a little bit of a lie if you are using keyword search, in which case contents might take a few seconds to retrieve.

Version:0.0.1

Key:metaphor-get-documents-content

View on GitHub

Exa (Formerly Metaphor) Overview#

The Exa (Formerly Metaphor) API enables you to enrich your applications with machine learning-powered insights and data processing capabilities. With Exa, you can perform advanced data analysis, extract meaningful patterns, and automate decision-making processes within your projects. By integrating this API with Pipedream, you can create seamless workflows that leverage these intelligent features alongside other services to streamline your operations, enhance data intelligence, and drive innovation.

Action Code#

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

export default {
  key: "metaphor-get-documents-content",
  name: "Get Contents of Documents",
  version: "0.0.1",
  description: "Retrieve contents of documents based on a list of document IDs. [See the documentation](https://docs.metaphor.systems/reference/contents). It is used to `instantly` get content for documents, given the IDs of the documents. We currently support extracts - the first 1000 tokens (~750 words) of parsed HTML for a site. **Note that each piece of content retrieved costs 1 request.** Also note that `instant` is a little bit of a lie if you are using keyword search, in which case contents might take a few seconds to retrieve.",
  type: "action",
  props: {
    metaphor,
    ids: {
      type: "string[]",
      label: "Ids",
      description: "An array of document IDs obtained from either `/search` or `/findSimilar` endpoints.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      metaphor,
      ids,
    } = this;

    const response = await metaphor.getContents({
      $,
      params: {
        ids,
      },
    });

    $.export("$summary", `${response.contents.length} content${response.contents.length > 1
      ? "s were"
      : " was"} successfully fetched!`);
    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 (Formerly Metaphor)	`metaphor`	`app`	This component uses the Exa (Formerly Metaphor) app.
Ids	`ids`	`string[]`	An array of document IDs obtained from either `/search` or `/findSimilar` endpoints.