Submit Image to Alttextify with AltTextify API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Submit Image to Alttextify with the AltTextify 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 AltTextify 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 Submit Image to Alttextify action
1. Connect your AltTextify account
2. Configure alert
3. Configure Async
4. Configure Image
5. Configure Language
6. Configure Max Characters
7. Optional- Configure Asset ID
8. Optional- Configure Keywords
9. Configure Ecommerce Run OCR
10. Optional- Configure Ecommerce Product Name
11. Optional- Configure Ecommerce Product Brand
12. Optional- Configure Ecommerce Product Color
13. Optional- Configure Ecommerce Product Size
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#

Submit Image to Alttextify on AltTextify

Description:Upload or submit an image to Alttextify for alt text generation. [See the documentation](https://apidoc.alttextify.net/#api-Image-UploadRawImage)

Version:0.0.1

Key:alttextify-submit-image

View on GitHub

Action Code#

import { getFileStreamAndMetadata } from "@pipedream/platform";
import alttextify from "../../alttextify.app.mjs";

export default {
  key: "alttextify-submit-image",
  name: "Submit Image to Alttextify",
  description: "Upload or submit an image to Alttextify for alt text generation. [See the documentation](https://apidoc.alttextify.net/#api-Image-UploadRawImage)",
  version: "0.0.1",
  type: "action",
  props: {
    alttextify,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Supported formats: JPEG, PNG, GIF, WEBP, BMP\nMaximum file size: 16 MB\nMinimum dimensions: 50 x 50 (smaller images may not be able to generate alt text).",
    },
    async: {
      type: "boolean",
      label: "Async",
      description: "Whether to add the image in the background or immediately (synchronously). If async is set to true, the API response will always be successful with an empty response body.",
      default: false,
    },
    image: {
      type: "string",
      label: "Image",
      description: "The URL of the file or path to the file saved to the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
    },
    lang: {
      type: "string",
      label: "Language",
      description: "The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.",
      default: "en",
    },
    maxChars: {
      type: "integer",
      label: "Max Characters",
      description: "Maximum length of the generated alt text.",
    },
    assetId: {
      type: "string",
      label: "Asset ID",
      description: "The unique identifier for the asset.",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English, even for alt text in other languages.",
      optional: true,
    },
    ecommerceRunOCR: {
      type: "boolean",
      label: "Ecommerce Run OCR",
      description: "Flag to indicate if OCR should be run on the product.",
    },
    ecommerceProductName: {
      type: "string",
      label: "Ecommerce Product Name",
      description: "The name of the product in the image.",
      optional: true,
    },
    ecommerceProductBrand: {
      type: "string",
      label: "Ecommerce Product Brand",
      description: "The brand of the product in the image.",
      optional: true,
    },
    ecommerceProductColor: {
      type: "string",
      label: "Ecommerce Product Color",
      description: "The color of the product in the image.",
      optional: true,
    },
    ecommerceProductSize: {
      type: "string",
      label: "Ecommerce Product Size",
      description: "The size of the product in the image.",
      optional: true,
    },
  },
  methods: {
    async streamToBase64(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];

        stream.on("data", (chunk) => {
          chunks.push(chunk);
        });

        stream.on("end", () => {
          const buffer = Buffer.concat(chunks);
          resolve(buffer.toString("base64"));
        });

        stream.on("error", (err) => {
          reject(err);
        });
      });
    },
  },
  async run({ $ }) {
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.image);
    const base64String = await this.streamToBase64(stream);

    const response = await this.alttextify.uploadImage({
      $,
      data: {
        async: this.async,
        image: `data:${metadata.contentType};base64,${base64String}`,
        lang: this.lang,
        maxChars: this.maxChars,
        assetId: this.assetId,
        keywords: this.keywords,
        ecommerce: {
          run_ocr: this.ecommerceRunOCR,
          product: {
            name: this.ecommerceProductName,
            brand: this.ecommerceProductBrand,
            color: this.ecommerceProductColor,
            size: this.ecommerceProductSize,
          },
        },
      },

    });

    $.export("$summary", `Successfully submitted image to Alttextify for alt text generation with Asset ID: ${response.asset_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
AltTextify	`alttextify`	`app`	This component uses the AltTextify app.
Async	`async`	`boolean`	Whether to add the image in the background or immediately (synchronously). If async is set to true, the API response will always be successful with an empty response body.
Image	`image`	`string`	The URL of the file or path to the file saved to the `/tmp` directory. See the documentation on working with files
Language	`lang`	`string`	The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.
Max Characters	`maxChars`	`integer`	Maximum length of the generated alt text.
Asset ID	`assetId`	`string`	The unique identifier for the asset.
Keywords	`keywords`	`string[]`	List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English, even for alt text in other languages.
Ecommerce Run OCR	`ecommerceRunOCR`	`boolean`	Flag to indicate if OCR should be run on the product.
Ecommerce Product Name	`ecommerceProductName`	`string`	The name of the product in the image.
Ecommerce Product Brand	`ecommerceProductBrand`	`string`	The brand of the product in the image.
Ecommerce Product Color	`ecommerceProductColor`	`string`	The color of the product in the image.
Ecommerce Product Size	`ecommerceProductSize`	`string`	The size of the product in the image.