Create PDF with CraftMyPDF API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create PDF with the CraftMyPDF 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 CraftMyPDF 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 Create PDF action
1. Connect your CraftMyPDF account
2. Configure Data
3. Optional- Configure Load Data From
4. Select a Template Id
5. Optional- Select a Template Version
6. Optional- Configure Expiration (in minutes)
7. Optional- Configure Output File
8. Optional- Configure Is CMYK
9. Optional- Configure Image Resample Res
10. Optional- Configure Cloud Storage
11. Optional- Select a PDF Standard
12. Configure Password Protected
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#

Create PDF on CraftMyPDF

Description:Create a new pdf. [See the documentation](https://craftmypdf.com/docs/index.html#tag/PDF-Generation-API/operation/create)

Version:0.0.2

Key:craftmypdf-create-pdf

View on GitHub

CraftMyPDF Overview#

CraftMyPDF is a powerful API that allows you to create dynamic and customizable PDF documents. By leveraging this API on Pipedream, you can automate the generation of invoices, reports, tickets, and any other document that requires a polished and professional look. Pipedream's serverless platform enables you to connect CraftMyPDF with numerous apps to create workflows that trigger PDF generation from events like form submissions, new database entries, or scheduled jobs.

Action Code#

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

export default {
  key: "craftmypdf-create-pdf",
  name: "Create PDF",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  description: "Create a new pdf. [See the documentation](https://craftmypdf.com/docs/index.html#tag/PDF-Generation-API/operation/create)",
  type: "action",
  props: {
    craftmypdf,
    data: {
      propDefinition: [
        craftmypdf,
        "data",
      ],
    },
    loadDataFrom: {
      propDefinition: [
        craftmypdf,
        "loadDataFrom",
      ],
      optional: true,
    },
    templateId: {
      propDefinition: [
        craftmypdf,
        "templateId",
      ],
    },
    version: {
      propDefinition: [
        craftmypdf,
        "templateVersion",
        ({ templateId }) => ({
          templateId,
        }),
      ],
      optional: true,
    },
    expiration: {
      propDefinition: [
        craftmypdf,
        "expiration",
      ],
      optional: true,
    },
    outputFile: {
      propDefinition: [
        craftmypdf,
        "outputFile",
      ],
      optional: true,
    },
    isCMYK: {
      type: "boolean",
      label: "Is CMYK",
      description: "Use CMYK color profile, default to 'false'.",
      optional: true,
    },
    imageResampleRes: {
      type: "integer",
      label: "Image Resample Res",
      description: "Optimize/downsample images of current PDF to a resolution(in DPI). This helps to reduce the PDF file size. Suggested values are 1200, 600, 300, 150 or 72.",
      optional: true,
    },
    cloudStorage: {
      propDefinition: [
        craftmypdf,
        "cloudStorage",
      ],
      optional: true,
    },
    pdfStandard: {
      type: "string",
      label: "PDF Standard",
      description: "Default to PDF1.7. PDFA3 is an experimental feature.",
      options: [
        "PDF1.7",
        "PDFA1B",
        "PDFA2",
        "PDFA3",
      ],
      optional: true,
    },
    passwordProtected: {
      type: "boolean",
      label: "Password Protected",
      description: "Enable password protection.",
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.passwordProtected) {
      props.password = {
        type: "string",
        label: "Password",
        description: "Specify a password.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      craftmypdf,
      loadDataFrom,
      templateId,
      outputFile,
      isCMYK,
      imageResampleRes,
      cloudStorage,
      pdfStandard,
      passwordProtected,
      ...data
    } = this;

    const response = await craftmypdf.createPDF({
      $,
      data: {
        ...data,
        load_data_from: loadDataFrom,
        template_id: templateId,
        export_type: "json",
        output_file: outputFile,
        is_cmyk: isCMYK,
        image_resample_res: imageResampleRes,
        directDownload: 0,
        cloud_storage: cloudStorage,
        pdf_standard: pdfStandard,
        password_protected: passwordProtected,
      },
    });

    $.export("$summary", `A new PDF with Id: ${response.transaction_ref} was successfully created!`);
    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
CraftMyPDF	`craftmypdf`	`app`	This component uses the CraftMyPDF app.
Data	`data`	`string`	JSON data based on the template structure.
Load Data From	`loadDataFrom`	`string`	Load data from an external URL. If this is specified, it will overwrite the `data`` property.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Template Version	`version`	`string`	Select a value from the drop down menu.
Expiration (in minutes)	`expiration`	`integer`	Expiration of the generated PDF in minutes. Default to 5 minutes. Range between 1 minute and 24 hours.
Output File	`outputFile`	`string`	Default to 'output.pdf'.
Is CMYK	`isCMYK`	`boolean`	Use CMYK color profile, default to 'false'.
Image Resample Res	`imageResampleRes`	`integer`	Optimize/downsample images of current PDF to a resolution(in DPI). This helps to reduce the PDF file size. Suggested values are 1200, 600, 300, 150 or 72.
Cloud Storage	`cloudStorage`	`integer`	Upload the generated PDFs/images to our storage CDN(Except export_type=file), default to `1`. If you have configured `Post Actions` to upload the PDFs/Images to your own S3, please set it to `0`.
PDF Standard	`pdfStandard`	`string`	Select a value from the drop down menu:`PDF1.7PDFA1BPDFA2PDFA3`
Password Protected	`passwordProtected`	`boolean`	Enable password protection.

Action Authentication#

CraftMyPDF uses API keys for authentication. When you connect your CraftMyPDF account, Pipedream securely stores the keys so you can easily authenticate to CraftMyPDF APIs in both code and no-code steps.

To retrieve your API keys,