Send Signature Request with Lumin PDF API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Send Signature Request with the Lumin PDF 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 Lumin PDF 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 Send Signature Request action
1. Connect your Lumin PDF account
2. Optional- Configure File URL
3. Optional- Configure File
4. Optional- Configure File URLs
5. Optional- Configure Files
6. Optional- Configure Signers
7. Optional- Configure Viewers
8. Configure Title
9. Configure Expires At
10. Optional- Configure Use Text Tags
11. Optional- Select a Signing Type
12. Optional- Configure Sender Email
13. Optional- Configure Subject
14. Optional- Configure Custom Email Title
15. Optional- Configure syncDir
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#

Send Signature Request on Lumin PDF

Description:Send a signature request to signers. [See the documentation](https://developers.luminpdf.com/api/send-signature-request/)

Version:0.0.1

Key:lumin_pdf-send-signature-request

View on GitHub

Action Code#

import {
  ConfigurationError,
  getFileStreamAndMetadata,
} from "@pipedream/platform";
import FormData from "form-data";
import { parseObject } from "../../common/utils.mjs";
import luminPdf from "../../lumin_pdf.app.mjs";

export default {
  key: "lumin_pdf-send-signature-request",
  name: "Send Signature Request",
  description: "Send a signature request to signers. [See the documentation](https://developers.luminpdf.com/api/send-signature-request/)",
  version: "0.0.1",
  type: "action",
  props: {
    luminPdf,
    fileUrl: {
      type: "string",
      label: "File URL",
      description: "The URL of a single file to be downloaded and signed. This field is mutually exclusive with `file`, `files`, and `File URLs`. Only one of these fields should be provided in the request.",
      optional: true,
    },
    file: {
      type: "string",
      label: "File",
      description: "A single path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`) to be sent for signature. This field is mutually exclusive with `File URL`, `Files`, and `File URLs`. Only one of these fields should be provided in the request.",
      optional: true,
    },
    fileUrls: {
      type: "string[]",
      label: "File URLs",
      description: "An array of URLs of files to be downloaded and signed. This field is mutually exclusive with `File`, `Files`, and `File URL`. Only one of these fields should be provided in the request.",
      optional: true,
    },
    files: {
      type: "string[]",
      label: "Files",
      description: "An array of path to files in the `/tmp` directory (for example, `/tmp/myFile.pdf`) to be sent for signature. This field is mutually exclusive with `File URL`, `Files`, and `File URLs`. Only one of these fields should be provided in the request.",
      optional: true,
    },
    signers: {
      type: "string[]",
      label: "Signers",
      description: "A list of objects of signers to add to your Signature Request. Format: `[{'email_address': 'email@example.com', 'name': 'John Doe', 'group': 1}, {'email_address': 'email2@example.com', 'name': 'Jane Doe', 'group': 2}]`. [See the documentation](https://developers.luminpdf.com/api/send-signature-request/) for more information.",
      optional: true,
    },
    viewers: {
      type: "string[]",
      label: "Viewers",
      description: "A list of objects of viewers to add to your Signature Request. Format: `[{'email_address': 'email@example.com', 'name': 'John Doe'}, {'email_address': 'email2@example.com', 'name': 'Jane Doe'}]`. [See the documentation](https://developers.luminpdf.com/api/send-signature-request/) for more information.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title you want to give the Signature Request.",
    },
    expiresAt: {
      type: "string",
      label: "Expires At",
      description: "When the Signature Request will expire. Should be later than today. In ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).",
    },
    useTextTags: {
      type: "boolean",
      label: "Use Text Tags",
      description: "Set to `true` to enable Text Tag parsing in your document. Your Text Tags will be converted into UI components for the user to interact with.",
      optional: true,
    },
    signingType: {
      type: "string",
      label: "Signing Type",
      description: "The signing order for the Signature Request.",
      options: [
        "SAME_TIME",
        "ORDER",
      ],
      optional: true,
    },
    senderEmail: {
      type: "string",
      label: "Sender Email",
      description: "The email address of the sender.",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the email.",
      optional: true,
    },
    customEmailTitle: {
      type: "string",
      label: "Custom Email Title",
      description: "The title of the email.",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    async appendFile(formData, fieldName, file) {
      const {
        stream,
        metadata,
      } = await getFileStreamAndMetadata(file);
      formData.append(fieldName, stream, {
        contentType: metadata.contentType,
        knownLength: metadata.size,
        filename: metadata.name,
      });
    },
  },
  async run({ $ }) {
    const formData = new FormData();
    const checkFiles = {};
    if (this.file) checkFiles.file = this.file;
    if (this.files) checkFiles.files = this.files;
    if (this.fileUrl) checkFiles.fileUrl = this.fileUrl;
    if (this.fileUrls) checkFiles.fileUrls = this.fileUrls;

    if (Object.keys(checkFiles).length > 1) {
      throw new ConfigurationError("Only one of `File URL`, `File`, `File URLs`, or `Files` should be provided in the request.");
    }
    if (Object.keys(checkFiles).length === 0) {
      throw new ConfigurationError("At least one of `File URL`, `File`, `File URLs`, or `Files` should be provided in the request.");
    }

    if (this.file) {
      await this.appendFile(formData, "file", this.file);
    }
    if (this.files) {
      for (const [
        index,
        file,
      ] of this.files.entries()) {
        await this.appendFile(formData, `files[${index}]`, file);
      }
    }
    if (this.fileUrl) {
      formData.append("file_url", this.fileUrl);
    }
    if (this.fileUrls) {
      for (const [
        index,
        fileUrl,
      ] of this.fileUrls.entries()) {
        formData.append(`file_urls[${index}]`, fileUrl);
      }
    }
    if (this.signers) {
      for (const [
        index,
        signer,
      ] of parseObject(this.signers).entries()) {
        for (const item of Object.keys(signer)) {
          formData.append(`signers[${index}][${item}]`, signer[item]);
        }
      }
    }
    if (this.viewers) {
      for (const [
        index,
        viewer,
      ] of parseObject(this.viewers).entries()) {
        for (const item of Object.keys(viewer)) {
          formData.append(`viewers[${index}][${item}]`, viewer[item]);
        }
      }
    }
    if (this.title) formData.append("title", this.title);
    if (this.expiresAt) formData.append("expires_at", Date.parse(this.expiresAt));
    if (this.useTextTags) formData.append("use_text_tags", `${this.useTextTags}`);
    if (this.signingType) formData.append("signing_type", this.signingType);
    if (this.senderEmail) formData.append("custom_email[sender_email]", this.senderEmail);
    if (this.senderEmail) formData.append("custom_email[subject_name]", this.subject);
    if (this.senderEmail) formData.append("custom_email[title]", this.customEmailTitle);

    const response = await this.luminPdf.sendSignatureRequest({
      $,
      headers: formData.getHeaders(),
      data: formData,
    });

    if (response) {
      $.export("$summary", `Successfully sent signature request ${response.signature_request.signature_request_id}`);
    }

    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
Lumin PDF	`luminPdf`	`app`	This component uses the Lumin PDF app.
File URL	`fileUrl`	`string`	The URL of a single file to be downloaded and signed. This field is mutually exclusive with `file`, `files`, and `File URLs`. Only one of these fields should be provided in the request.
File	`file`	`string`	A single path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`) to be sent for signature. This field is mutually exclusive with `File URL`, `Files`, and `File URLs`. Only one of these fields should be provided in the request.
File URLs	`fileUrls`	`string[]`	An array of URLs of files to be downloaded and signed. This field is mutually exclusive with `File`, `Files`, and `File URL`. Only one of these fields should be provided in the request.
Files	`files`	`string[]`	An array of path to files in the `/tmp` directory (for example, `/tmp/myFile.pdf`) to be sent for signature. This field is mutually exclusive with `File URL`, `Files`, and `File URLs`. Only one of these fields should be provided in the request.
Signers	`signers`	`string[]`	A list of objects of signers to add to your Signature Request. Format: `[{'email_address': 'email@example.com', 'name': 'John Doe', 'group': 1}, {'email_address': 'email2@example.com', 'name': 'Jane Doe', 'group': 2}]`. See the documentation for more information.
Viewers	`viewers`	`string[]`	A list of objects of viewers to add to your Signature Request. Format: `[{'email_address': 'email@example.com', 'name': 'John Doe'}, {'email_address': 'email2@example.com', 'name': 'Jane Doe'}]`. See the documentation for more information.
Title	`title`	`string`	The title you want to give the Signature Request.
Expires At	`expiresAt`	`string`	When the Signature Request will expire. Should be later than today. In ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
Use Text Tags	`useTextTags`	`boolean`	Set to `true` to enable Text Tag parsing in your document. Your Text Tags will be converted into UI components for the user to interact with.
Signing Type	`signingType`	`string`	Select a value from the drop down menu:`SAME_TIMEORDER`
Sender Email	`senderEmail`	`string`	The email address of the sender.
Subject	`subject`	`string`	The subject of the email.
Custom Email Title	`customEmailTitle`	`string`	The title of the email.
syncDir	`syncDir`	`dir`