Upload Video with Hippo Video API on New Image Impression from Hyperise API

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

Trigger workflow on

New Image Impression from the Hyperise API

Next, do this

Upload Video with the Hippo Video 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 Hyperise trigger and Hippo Video action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Image Impression trigger
1. Connect your Hyperise account
2. Configure timer
3. Select a Image Template Hash
Configure the Upload Video action
1. Connect your Hippo Video account
2. Configure Title
3. Configure Video 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 Image Impression on Hyperise

Description:Emit new event when a new personalised image is viewed. [See the documentation](https://support.hyperise.com/en/api/Image-Views-API)

Version:0.0.1

Key:hyperise-new-image-impression

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.

Trigger Code#

import hyperise from "../../hyperise.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "hyperise-new-image-impression",
  name: "New Image Impression",
  description: "Emit new event when a new personalised image is viewed. [See the documentation](https://support.hyperise.com/en/api/Image-Views-API)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    hyperise,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    imageTemplateHash: {
      propDefinition: [
        hyperise,
        "imageTemplateHash",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || this.oneDayAgo();
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    oneDayAgo() {
      return new Date(Date.now() - 24 * 60 * 60 * 1000).toISOString()
        .slice(0, 19) + "Z";
    },
    emitEvent(data) {
      const meta = this.generateMeta(data);
      this.$emit(data, meta);
    },
    generateMeta(data) {
      return {
        id: data.id,
        summary: `New View of Image: ${data.image_name}`,
        ts: Date.parse(data.processed_at),
      };
    },
  },
  async run() {
    const lastDate = this._getLastDate();
    let maxDate = lastDate;
    const impressions = [];
    const results = await this.hyperise.getImageViews({
      params: {
        image_hash: this.imageTemplateHash,
        date_from: lastDate,
      },
    });
    for (const impression of results) {
      const ts = Date.parse(impression.processed_at);
      if (ts > Date.parse(lastDate)) {
        impressions.push(impression);
        if (ts > Date.parse(maxDate)) {
          maxDate = impression.processed_at;
        }
      }
    }
    impressions.reverse().forEach((impression) => this.emitEvent(impression));
    this._setLastDate(maxDate);
  },
  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
Hyperise	`hyperise`	`app`	This component uses the Hyperise app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Image Template Hash	`imageTemplateHash`	`string`	Select a value from the drop down menu.

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

Action#

Upload Video on Hippo Video

Description:Uploads a video from a given URL. [See the documentation](https://help.hippovideo.io/support/solutions/articles/19000100703-import-api)

Version:0.0.2

Key:hippo_video-upload-video

View on GitHub

Hippo Video Overview#

The Hippo Video API lets you harness the power of video in your business processes. Through Pipedream, you can automate video creation, management, and distribution workflows. This means you can trigger actions in Hippo Video based on events from other apps, or use Hippo Video events to kick off processes elsewhere. Whether it's automating video emails in your CRM, monitoring video analytics, or managing video content at scale, Pipedream's serverless platform empowers you to build and run workflows seamlessly.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import hippoVideo from "../../hippo_video.app.mjs";

export default {
  key: "hippo_video-upload-video",
  name: "Upload Video",
  description: "Uploads a video from a given URL. [See the documentation](https://help.hippovideo.io/support/solutions/articles/19000100703-import-api)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    hippoVideo,
    title: {
      type: "string",
      label: "Title",
      description: "Title of the video.",
    },
    url: {
      type: "string",
      label: "Video URL",
      description: "Public URL of the videos to be downloaded and uploaded to HippoVideo.",
    },
  },
  async run({ $ }) {
    const response = await this.hippoVideo.uploadVideo({
      $,
      data: {
        title: this.title,
        url: this.url,
      },
    });

    if (response.code != "200") throw new ConfigurationError(response.message);

    $.export("$summary", `Video uploaded successfully with Id: ${response.video_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
Hippo Video	`hippoVideo`	`app`	This component uses the Hippo Video app.
Title	`title`	`string`	Title of the video.
Video URL	`url`	`string`	Public URL of the videos to be downloaded and uploaded to HippoVideo.

Action Authentication#

Hippo Video uses OAuth authentication. When you connect your Hippo Video account, Pipedream will open a popup window where you can sign into Hippo Video and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Hippo Video API.

Pipedream requests the following authorization scopes when you connect your account: