Document Classifier with PDF.co API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Document Classifier with the PDF.co 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 PDF.co 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 Document Classifier action
1. Connect your PDF.co account
2. Configure URL
3. Optional- Configure HTTP Username
4. Optional- Configure HTTP Password
5. Optional- Configure Rules CSV
6. Optional- Configure Case Sensitive
7. Optional- Configure PDF Password
8. Optional- Configure Inline
9. Optional- Configure Name
10. Optional- Configure Expiration
11. Optional- Configure Async
12. Optional- Configure Profiles
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#

Document Classifier on PDF.co

Description:Auto classification of incoming documents. [See docs here](https://apidocs.pdf.co/01-1-document-classifier)

Version:0.0.1

Key:pdf_co-document-classifier

View on GitHub

PDF.co Overview#

PDF.co API on Pipedream opens up opportunities for automating document handling tasks. You can create PDFs from scratch, merge multiple documents, extract text or data, convert PDFs to different formats, and even perform complex operations like filling out forms programmatically. With Pipedream's serverless platform, these capabilities can be integrated into workflows that respond to events, schedule tasks, or trigger on specific conditions, streamlining processes that involve PDF manipulation.

Action Code#

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

export default {
  name: "Document Classifier",
  description: "Auto classification of incoming documents. [See docs here](https://apidocs.pdf.co/01-1-document-classifier)",
  key: "pdf_co-document-classifier",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    url: {
      propDefinition: [
        app,
        "url",
      ],
    },
    httpusername: {
      propDefinition: [
        app,
        "httpusername",
      ],
    },
    httppassword: {
      propDefinition: [
        app,
        "httppassword",
      ],
    },
    rulescsv: {
      type: "string",
      label: "Rules CSV",
      description: "Define custom classification rules in CSV format. [learn more](https://apidocs.pdf.co/01-1-document-classifier)",
      optional: true,
    },
    caseSensitive: {
      propDefinition: [
        app,
        "caseSensitive",
      ],
    },
    password: {
      propDefinition: [
        app,
        "password",
      ],
    },
    inline: {
      propDefinition: [
        app,
        "inline",
      ],
    },
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    expiration: {
      propDefinition: [
        app,
        "expiration",
      ],
    },
    async: {
      propDefinition: [
        app,
        "async",
      ],
    },
    profiles: {
      propDefinition: [
        app,
        "profiles",
      ],
    },
  },
  async run({ $ }) {
    const payload = {
      url: this.url,
      httpusername: this.httpusername,
      httppassword: this.httppassword,
      rulescsv: this.rulescsv,
      caseSensitive: this.caseSensitive,
      inline: this.inline,
      password: this.password,
      async: this.async,
      name: this.name,
      expiration: this.expiration,
      profiles: this.profiles,
    };
    const endpoint = "/pdf/classifier";
    const response = await this.app.genericRequest(
      $,
      payload,
      endpoint,
    );
    $.export("$summary", `Successfully classified PDF from: ${this.url}`);
    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
PDF.co	`app`	`app`	This component uses the PDF.co app.
URL	`url`	`string`	URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage.
HTTP Username	`httpusername`	`string`	HTTP auth user name if required to access source url.
HTTP Password	`httppassword`	`string`	HTTP auth password if required to access source url.
Rules CSV	`rulescsv`	`string`	Define custom classification rules in CSV format. learn more
Case Sensitive	`caseSensitive`	`boolean`	Defines if keywords in rules are case sensitive or not.
PDF Password	`password`	`string`	Password of PDF file.
Inline	`inline`	`boolean`	Must be one of: true to return data as inline or false to return link to output file (default).
Name	`name`	`string`	File name for generated output.
Expiration	`expiration`	`integer`	Output link expiration in minutes. Default is 60 (i.e. 60 minutes or 1 hour).
Async	`async`	`boolean`	Runs processing asynchronously. Returns JobId.
Profiles	`profiles`	`any`	Use this parameter to set additional configuration for fine tuning and extra options. Explore PDF.co for profile examples.