Start Render with Shotstack API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Start Render with the Shotstack 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 Shotstack 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 Start Render action
1. Connect your Shotstack account
2. Configure Timeline
3. Select a Output Format
4. Select a Output Resolution
5. Optional- Configure Callback 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#

Start Render on Shotstack

Description:Initiate rendering of a video using a timeline created in Shotstack API. [See the documentation here](https://shotstack.io/docs/api/?shell#render-asset).

Version:0.0.1

Key:shotstack-start-render

View on GitHub

Shotstack Overview#

The Shotstack API is a video editing platform that allows you to automate the creation and production of videos. With it, you can edit clips, add transitions, overlays, and backgrounds, and even include music in your videos. Integrating Shotstack with Pipedream can supercharge your workflow by automating the video creation process. You can trigger video edits in response to various events, manage assets, or even kick off rendering jobs based on data from other apps and services.

Action Code#

import app from "../../shotstack.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "shotstack-start-render",
  name: "Start Render",
  description: "Initiate rendering of a video using a timeline created in Shotstack API. [See the documentation here](https://shotstack.io/docs/api/?shell#render-asset).",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    timeline: {
      type: "string",
      label: "Timeline",
      description: "The timeline to render. [See the documentation for the timeline object here](https://shotstack.io/docs/api/?shell#tocs_timeline)",
    },
    outputFormat: {
      type: "string",
      label: "Output Format",
      description: "The output format and type of media file to generate.",
      options: Object.values(constants.OUTPUT_FORMAT),
    },
    outputResolution: {
      type: "string",
      label: "Output Resolution",
      description: "The output resolution of the video or image.",
      options: Object.values(constants.OUTPUT_RESOLUTION),
    },
    callback: {
      description: "An optional webhook callback URL used to receive status notifications when a render completes or fails.",
      optional: true,
      propDefinition: [
        app,
        "callback",
      ],
    },
  },
  methods: {
    startRender(args = {}) {
      return this.app.post({
        path: "/render",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      timeline,
      outputFormat,
      outputResolution,
      callback,
    } = this;

    const response =
      await this.startRender({
        step,
        data: {
          timeline: utils.parse(timeline),
          output: {
            format: outputFormat,
            resolution: outputResolution,
          },
          callback,
        },
      });

    step.export("$summary", `Render started with id ${response.response.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
Shotstack	`app`	`app`	This component uses the Shotstack app.
Timeline	`timeline`	`string`	The timeline to render. See the documentation for the timeline object here
Output Format	`outputFormat`	`string`	Select a value from the drop down menu:`{ "label": "MP4 video file", "value": "mp4" }{ "label": "Animated GIF", "value": "gif" }{ "label": "JPG image file", "value": "jpg" }{ "label": "PNG image file", "value": "png" }{ "label": "BMP image file", "value": "bmp" }{ "label": "MP3 audio file (audio only)", "value": "mp3" }`
Output Resolution	`outputResolution`	`string`	Select a value from the drop down menu:`{ "label": "1080 - 1920px x 1080px @ 25fps", "value": "1080" }{ "label": "Preview - 512px x 288px @ 15fps", "value": "preview" }{ "label": "Mobile - 640px x 360px @ 25fps", "value": "mobile" }{ "label": "SD - 1024px x 576px @ 25fps", "value": "sd" }{ "label": "HD - 1280px x 720px @ 25fps", "value": "hd" }`
Callback URL	`callback`	`string`	An optional webhook callback URL used to receive status notifications when a render completes or fails.