Create Prediction with Replicate API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Prediction with the Replicate API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Typeform trigger and Replicate 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 Prediction action
1. Connect your Replicate account
2. Select a Collection Id
3. Select a Model Id
4. Select a Model Version
5. Configure Input
6. Optional- Configure Webhook
7. Optional- Select one or more Webhook Events Filter
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 Prediction on Replicate

Description:Create a new prediction [See the documentation](https://replicate.com/docs/reference/http#predictions.create)

Version:0.0.1

Key:replicate-create-prediction

View on GitHub

Replicate Overview#

The Replicate API allows you to access a wide array of machine learning models for tasks such as image generation, text-to-image, and more. Using Pipedream, you can orchestrate these models to automate content creation, analyze media, or enhance data with AI-generated insights. Pipedream's serverless platform empowers you to create workflows that react to events, schedule tasks, and integrate with numerous other services, all harnessing the power of Replicate's AI models.

Action Code#

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

export default {
  key: "replicate-create-prediction",
  name: "Create Prediction",
  version: "0.0.1",
  description: "Create a new prediction [See the documentation](https://replicate.com/docs/reference/http#predictions.create)",
  type: "action",
  props: {
    replicate,
    collectionSlug: {
      propDefinition: [
        replicate,
        "collectionSlug",
      ],
    },
    modelId: {
      propDefinition: [
        replicate,
        "modelId",
        ({ collectionSlug }) => ({
          collectionSlug,
        }),
      ],
    },
    version: {
      propDefinition: [
        replicate,
        "modelVersion",
        ({ modelId }) => ({
          modelId,
        }),
      ],
    },
    input: {
      type: "string",
      label: "Input",
      description: "The model's input as a JSON object. The input depends on what model you are running. To see the available inputs, click the \"Run with API\" tab on the model you are running. For example, stability-ai/stable-diffusion takes prompt as an input.",
    },
    webhook: {
      type: "string",
      label: "Webhook",
      description: "An HTTPS URL for receiving a webhook when the prediction has new output.",
      optional: true,
    },
    webhookEventsFilter: {
      type: "string[]",
      label: "Webhook Events Filter",
      description: "By default, we will send requests to your webhook URL whenever there are new logs, new outputs, or the prediction has finished. [See de documentartion here](https://replicate.com/docs/reference/http#predictions.create--webhook_events_filter) for more details.",
      options: [
        "start",
        "output",
        "logs",
        "completed",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      replicate,
      version,
      input,
      webhook,
      webhookEventsFilter,
    } = this;

    const response = await replicate.createPrediction({
      $,
      data: {
        version,
        input: JSON.parse(input),
        webhook,
        webhook_events_filter: webhookEventsFilter,
      },
    });

    $.export("$summary", `A new prediction with Id: ${response.id} 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
Replicate	`replicate`	`app`	This component uses the Replicate app.
Collection Id	`collectionSlug`	`string`	Select a value from the drop down menu.
Model Id	`modelId`	`string`	Select a value from the drop down menu.
Model Version	`version`	`string`	Select a value from the drop down menu.
Input	`input`	`string`	The model's input as a JSON object. The input depends on what model you are running. To see the available inputs, click the "Run with API" tab on the model you are running. For example, stability-ai/stable-diffusion takes prompt as an input.
Webhook	`webhook`	`string`	An HTTPS URL for receiving a webhook when the prediction has new output.
Webhook Events Filter	`webhookEventsFilter`	`string[]`	Select a value from the drop down menu:`startoutputlogscompleted`