Upload Document for Parsing with Affinda API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Upload Document for Parsing with the Affinda 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 Affinda 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 Upload Document for Parsing action
1. Connect your Affinda account
2. Select a Organization
3. Select a Workspace
4. Select a Collection
5. Configure URL
6. Optional- Configure Wait
7. Optional- Configure Identifier
8. Optional- Configure File Name
9. Optional- Configure Expiry Time
10. Optional- Configure Language
11. Optional- Configure Reject Duplicates
12. Optional- Configure Region Bias
13. Optional- Configure Low Priority
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#

Upload Document for Parsing on Affinda

Description:Uploads a document for parsing. [See docs here](https://docs.affinda.com/reference/createdocument)

Version:0.0.1

Key:affinda-upload-document-from-url

View on GitHub

Affinda Overview#

The Affinda API offers a suite of powerful tools for document analysis and extraction, enabling you to automate the processing of resumes, invoices, bank statements, and other documents. By parsing detailed information from documents, Affinda can transform unstructured data into structured, actionable insights. With Pipedream, you can integrate Affinda's capabilities into serverless workflows, connecting to hundreds of apps to automate tasks like candidate screening, financial data aggregation, or content management.

Action Code#

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

export default {
  key: "affinda-upload-document-from-url",
  name: "Upload Document for Parsing",
  description: "Uploads a document for parsing. [See docs here](https://docs.affinda.com/reference/createdocument)",
  version: "0.0.1",
  type: "action",
  props: {
    affinda,
    organization: {
      propDefinition: [
        affinda,
        "organization",
      ],
    },
    workspace: {
      propDefinition: [
        affinda,
        "workspace",
        (c) => ({
          organization: c.organization,
        }),
      ],
    },
    collection: {
      propDefinition: [
        affinda,
        "collection",
        (c) => ({
          workspace: c.workspace,
        }),
      ],
    },
    url: {
      type: "string",
      label: "URL",
      description: "URL to download the document.",
    },
    wait: {
      type: "boolean",
      label: "Wait",
      description: "If `true`, will return a response only after processing has completed. If `false`, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to `true`.",
      optional: true,
    },
    identifier: {
      type: "string",
      label: "Identifier",
      description: "Specify a custom identifier for the document.",
      optional: true,
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "Optional filename of the file",
      optional: true,
    },
    expiryTime: {
      type: "string",
      label: "Expiry Time",
      description: "The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.",
      optional: true,
    },
    rejectDuplicates: {
      type: "boolean",
      label: "Reject Duplicates",
      description: "If `true`, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If `false`, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.",
      optional: true,
    },
    regionBias: {
      type: "object",
      label: "Region Bias",
      description: "A JSON representation of the RegionBias object. Example: `{\"country\": \"vn\"}`",
      optional: true,
    },
    lowPriority: {
      type: "boolean",
      label: "Low Priority",
      description: "Explicitly mark this document as low priority.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (typeof this.regionBias === "string") {
      this.regionBias = JSON.parse(this.regionBias);
    }

    const response = await this.affinda.uploadDocument({
      $,
      data: {
        url: this.url,
        collection: this.collection,
        workspace: this.workspace,
        wait: this.wait,
        identifier: this.identifier,
        fileName: this.fileName,
        expiryTime: this.expiryTime,
        language: this.language,
        rejectDuplicates: this.rejectDuplicates,
        regionBias: this.regionBias,
        lowPriority: this.lowPriority,
      },
    });
    $.export("$summary", "Document uploaded successfully");
    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
Affinda	`affinda`	`app`	This component uses the Affinda app.
Organization	`organization`	`string`	Select a value from the drop down menu.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
URL	`url`	`string`	URL to download the document.
Wait	`wait`	`boolean`	If `true`, will return a response only after processing has completed. If `false`, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to `true`.
Identifier	`identifier`	`string`	Specify a custom identifier for the document.
File Name	`fileName`	`string`	Optional filename of the file
Expiry Time	`expiryTime`	`string`	The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Language	`language`	`string`	Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
Reject Duplicates	`rejectDuplicates`	`boolean`	If `true`, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If `false`, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
Region Bias	`regionBias`	`object`	A JSON representation of the RegionBias object. Example: `{"country": "vn"}`
Low Priority	`lowPriority`	`boolean`	Explicitly mark this document as low priority.