Create a PDF with APITemplate.io API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create a PDF with the APITemplate.io 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 APITemplate.io 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 a PDF action
1. Connect your APITemplate.io account
2. Optional- Select a API Endpoints
3. Select a Template Id
4. Configure Data
5. Optional- Configure Expiration
6. Optional- Configure Meta
7. Optional- Select a Export Type
8. Optional- Configure Output HTML
9. Optional- Select a Output Format
10. Optional- Configure Filename
11. Optional- Configure Image Resample Res
12. Optional- Configure Is CMYK
13. Optional- Configure Async
14. Optional- Configure Webhook URL
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 a PDF on APITemplate.io

Description:Create a PDF file with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-pdf) for more information

Version:0.0.1

Key:apitemplate_io-create-pdf

View on GitHub

APITemplate.io Overview#

APITemplate.io's API unleashes creative automation for generating images or PDFs from predefined templates. It's a powerful tool for creating custom visual content on-the-fly, ideal for marketers, developers, or content creators who need to personalize images or documents at scale. With Pipedream's integration capabilities, you can construct workflows that trigger custom media creation based on specific triggers or actions from a wide range of apps and services.

Action Code#

import app from "../../app/apitemplate_io.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create a PDF",
    description: "Create a PDF file with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-pdf) for more information",
    key: "apitemplate_io-create-pdf",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        apiEndpoints: {
            propDefinition: [
                app,
                "apiEndpoints",
            ],
        },
        templateId: {
            propDefinition: [
                app,
                "templateId",
                () => ({
                    format: "PDF",
                }),
            ],
        },
        data: {
            propDefinition: [
                app,
                "data",
            ],
        },
        expiration: {
            propDefinition: [
                app,
                "expiration",
            ],
        },
        meta: {
            propDefinition: [
                app,
                "meta",
            ],
        },
        exportType: {
            propDefinition: [
                app,
                "exportType",
            ],
        },
        outputHtml: {
            propDefinition: [
                app,
                "outputHtml",
            ],
        },
        outputFormat: {
            propDefinition: [
                app,
                "outputFormat",
            ],
        },
        filename: {
            propDefinition: [
                app,
                "filename",
            ],
        },
        imageResampleRes: {
            propDefinition: [
                app,
                "imageResampleRes",
            ],
        },
        isCmyk: {
            propDefinition: [
                app,
                "isCmyk",
            ],
        },
        async: {
            propDefinition: [
                app,
                "async",
            ],
        },
        webhookUrl: {
            propDefinition: [
                app,
                "webhookUrl",
            ],
        },
    },
    methods: {
        boolToInt(prop) {
            if (typeof (prop) === "boolean") {
                if (prop) {
                    return 1;
                }
                return 0;
            }
            return prop;
        },
    },
    async run({ $ }) {
        const params = {
            template_id: this.templateId,
            expiration: this.expiration,
            meta: this.meta,
            export_type: this.exportType,
            output_html: this.boolToInt(this.outputHtml),
            output_format: this.outputFormat,
            filename: this.filename,
            image_resample_res: this.imageResampleRes,
            is_cmyk: this.boolToInt(this.isCmyk),
            async: this.boolToInt(this.async),
            webhook_url: this.webhookUrl,
        };
        const response = await this.app.createImage($, this.apiEndpoints, params, this.data);
        $.export("$summary", `Successfully created a new PDF: ${response.transaction_ref}`);
        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
APITemplate.io	`app`	`app`	This component uses the APITemplate.io app.
API Endpoints	`apiEndpoints`	`string`	Select a value from the drop down menu:`{ "label": "Default (Singapore)", "value": "https://rest.apitemplate.io" }{ "label": "Europe (Frankfurt)", "value": "https://rest-de.apitemplate.io" }{ "label": "US East (N. Virginia)", "value": "https://rest-us.apitemplate.io" }{ "label": "Australia (Sydney)", "value": "https://rest-au.apitemplate.io" }{ "label": "Alternative Default (Singapore)", "value": "https://rest-alt.apitemplate.io" }{ "label": "Alternative Europe (Frankfurt)", "value": "https://rest-alt-de.apitemplate.io" }{ "label": "Alternative US East (N. Virginia)", "value": "https://rest-alt-us.apitemplate.io" }`
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Data	`data`	`any`	Object to replace values on the template, you can check here for the JSON example for your template.
Expiration	`expiration`	`integer`	Expiration of the generated image in minutes(default to `0`, store permanently).
Meta	`meta`	`string`	Specify an external reference ID for your own reference. It appears in the `list-objects` API.
Export Type	`exportType`	`string`	Select a value from the drop down menu:`jsonfile`
Output HTML	`outputHtml`	`boolean`	Whether it should output html or not
Output Format	`outputFormat`	`string`	Select a value from the drop down menu:`pdfhtml`
Filename	`filename`	`string`	Default to UUID (e.g 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf). Use this to specify custom file name, it should end with `.pdf`
Image Resample Res	`imageResampleRes`	`integer`	We embed the original images by default, meaning large PDF file sizes. Specifying this option helps reduce the PDF file size. Common values are `72`, `96`, `150`, `300` and `600`.
Is CMYK	`isCmyk`	`boolean`	Use CMYK color profile, Default to `false`
Async	`async`	`boolean`	To generate PDF asynchronously, set the value to `true` and the API call returns immediately. Once the PDF document is generated, we will make a HTTP/HTTPS GET to your webhook and will retry for 3 times before giving up.
Webhook URL	`webhookUrl`	`string`	It is the URL of your webhook URL, it starts with `http://` or `https://` and has to be urlencoded.

Action Authentication#

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

To retrieve your API key,