Create Personalised Short Link with Hyperise API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Personalised Short Link with the Hyperise 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 Hyperise 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 Personalised Short Link action
1. Connect your Hyperise account
2. Select a Image Template Hash
3. Configure Destination URL
4. Configure Page Title
5. Configure Page Description
6. Optional- Configure First Name
7. Optional- Configure Last Name
8. Optional- Configure Profile URL
9. Optional- Configure Job Title
10. Optional- Configure Email
11. Optional- Configure Phone
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 Personalised Short Link on Hyperise

Description:Creates a personalised short URL from provided inputs. [See the documentation](https://support.hyperise.com/en/api/Personalised-Short-Links-API)

Version:0.0.1

Key:hyperise-create-personalised-short-link

View on GitHub

Hyperise Overview#

The Hyperise API lets you dynamically personalize images with user-specific data, making it easier to create tailored visual content for each recipient. With Pipedream, you can automate this personalization process by integrating Hyperise with various apps to generate and share custom images on the fly. This could be particularly useful for marketing campaigns, sales outreach, or social media engagement where personalized content significantly boosts user interaction.

Action Code#

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

export default {
  key: "hyperise-create-personalised-short-link",
  name: "Create Personalised Short Link",
  description: "Creates a personalised short URL from provided inputs. [See the documentation](https://support.hyperise.com/en/api/Personalised-Short-Links-API)",
  version: "0.0.1",
  type: "action",
  props: {
    hyperise,
    imageTemplateHash: {
      propDefinition: [
        hyperise,
        "imageTemplateHash",
      ],
    },
    destinationUrl: {
      type: "string",
      label: "Destination URL",
      description: "The URL to create a personalised short URL for",
    },
    pageTitle: {
      type: "string",
      label: "Page Title",
      description: "Title of the page",
    },
    pageDescription: {
      type: "string",
      label: "Page Description",
      description: "Description of the page",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Personalisation Data - first name",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Personalisation Data",
      optional: true,
    },
    profileUrl: {
      type: "string",
      label: "Profile URL",
      description: "Personalisation Data - Image URL of the prospects profile image",
      optional: true,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "Personalisation Data - job title",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Personalisation Data - email address",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Personalisation Data - phone number",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.hyperise.createPersonalisedShortUrl({
      $,
      data: {
        image_hash: this.imageTemplateHash,
        url: this.destinationUrl,
        title: this.pageTitle,
        desc: this.pageDescription,
        query_params: {
          first_name: this.firstName,
          last_name: this.lastName,
          profile_url: this.profileUrl,
          job_title: this.jobTitle,
          email: this.email,
          phone: this.phone,
        },
      },
    });
    $.export("$summary", `Successfully created personalised short URL: ${response.link}`);
    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
Hyperise	`hyperise`	`app`	This component uses the Hyperise app.
Image Template Hash	`imageTemplateHash`	`string`	Select a value from the drop down menu.
Destination URL	`destinationUrl`	`string`	The URL to create a personalised short URL for
Page Title	`pageTitle`	`string`	Title of the page
Page Description	`pageDescription`	`string`	Description of the page
First Name	`firstName`	`string`	Personalisation Data - first name
Last Name	`lastName`	`string`	Personalisation Data
Profile URL	`profileUrl`	`string`	Personalisation Data - Image URL of the prospects profile image
Job Title	`jobTitle`	`string`	Personalisation Data - job title
Email	`email`	`string`	Personalisation Data - email address
Phone	`phone`	`string`	Personalisation Data - phone number

Action Authentication#

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

To retrieve your API tokens,

Navigate to your Hyperise and sign in
Go to “Settings” > “API”

About Hyperise#

Hyperise is essentially an image personalisation toolkit. These images can be used in outreach and on your website landing pages. Hyperise integrates with 1000's of MarTech, so whatever your outreach and website builder tools you're using, we most likely integrate with them.