Create Personalised Short Link with Hyperise API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Create Personalised Short Link with the Hyperise API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Personalised Short Link with Hyperise API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Hyperise

Try it

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

Typeform + Hyperise

Try it

Create Personalised Short Link with Hyperise API on New Submission (Instant) from Jotform API

Jotform + Hyperise

Try it

Create Personalised Short Link with Hyperise API on New Scheduled Tasks from Pipedream API

Pipedream + Hyperise

Try it

Create Personalised Short Link with Hyperise API on npm Download Counts from npm API

npm + Hyperise

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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
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

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.