Get Component with Pipedream API on New Image Impression from Hyperise API

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

Trigger workflow on

New Image Impression from the Hyperise API

Next, do this

Get Component with the Pipedream 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 Pipedream 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 Get Component action
1. Connect your Pipedream account
2. Configure Component Key
3. Optional- Configure Pipedream Registry
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#

Get Component on Pipedream

Description:Get info for a published component. [See docs](https://pipedream.com/docs/api/rest/#get-a-component)

Version:0.1.0

Key:pipedream-get-component

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

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

export default {
  key: "pipedream-get-component",
  name: "Get Component",
  description: "Get info for a published component. [See docs](https://pipedream.com/docs/api/rest/#get-a-component)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    componentKey: {
      propDefinition: [
        pipedream,
        "componentKey",
      ],
    },
    globalRegistry: {
      type: "boolean",
      label: "Pipedream Registry",
      description: "Defaults to `true`. If set to `true`, this will fetch component data from the public Pipedream registry. Set to `false` to search your private published components.",
      optional: true,
      default: true,
    },
  },
  async run({ $ }) {
    const { data } = await this.pipedream.getComponent(this.componentKey, this.globalRegistry);

    if (data) {
      $.export("$summary", `Succesfully fetched ${this.componentKey}`);
      return data;
    }

    console.log(`${this.componentKey} was not found`);
  },
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Component Key	`componentKey`	`string`	The component key (identified by the key property within the component's source code) you'd like to fetch metadata for (example: `github-new-commit-instant`)
Pipedream Registry	`globalRegistry`	`boolean`	Defaults to `true`. If set to `true`, this will fetch component data from the public Pipedream registry. Set to `false` to search your private published components.

Action Authentication#

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

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Hyperise#

Other Popular Integrations#

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

Pipedream + Hyperise

Try it

Create a Subscription with Pipedream API on New Image Impression from Hyperise API

Hyperise + Pipedream

Try it

Delete a Subscription with Pipedream API on New Image Impression from Hyperise API

Hyperise + Pipedream

Try it

Generate Component Code with Pipedream API on New Image Impression from Hyperise API

Hyperise + Pipedream

Try it

Popular Triggers#

New Image Impression from the Hyperise API

Emit new event when a new personalised image is viewed. See the documentation

Try it

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it