Register Someone For A Session with Livestorm API on New Image Impression from Hyperise API

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

Trigger workflow on

New Image Impression from the Hyperise API

Next, do this

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 Livestorm 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 Register Someone For A Session action
1. Connect your Livestorm account
2. Select a Session ID
3. Optional- Configure Referrer
4. Optional- Configure UTM Source
5. Optional- Configure UTM Medium
6. Optional- Configure UTM Campaign
7. Optional- Configure UTM Term
8. Optional- Configure UTM Content
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#

Description:Register a new participant for a session (either an external registrant or internal team member). [See the Documentation](https://developers.livestorm.co/reference/post_sessions-id-people)

Version:0.0.2

Key:livestorm-register-someone-for-session

View on GitHub

Livestorm Overview#

The Livestorm API opens up a world of possibilities for event management automation. With this API, you can harness data from your webinars and online events to drive engagement, personalize follow-ups, and streamline event operations. Integrating Livestorm with Pipedream allows you to construct workflows that can react to event triggers, sync data across platforms, and automate repetitive tasks. Whether you're looking to enhance participant engagement, capture leads in your CRM, or trigger personalized email campaigns post-event, Pipedream's serverless platform makes it easy to connect Livestorm with other apps and services.

Action Code#

import app from "../../livestorm.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "livestorm-register-someone-for-session",
  name: "Register Someone For A Session",
  description: "Register a new participant for a session (either an external registrant or internal team member). [See the Documentation](https://developers.livestorm.co/reference/post_sessions-id-people)",
  type: "action",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    sessionId: {
      reloadProps: true,
      propDefinition: [
        app,
        "sessionId",
      ],
    },
    referrer: {
      type: "string",
      label: "Referrer",
      description: "The referrer of the person registering for the session.",
      optional: true,
    },
    utmSource: {
      type: "string",
      label: "UTM Source",
      description: "The UTM source of the person registering for the session.",
      optional: true,
    },
    utmMedium: {
      type: "string",
      label: "UTM Medium",
      description: "The UTM medium of the person registering for the session.",
      optional: true,
    },
    utmCampaign: {
      type: "string",
      label: "UTM Campaign",
      description: "The UTM campaign of the person registering for the session.",
      optional: true,
    },
    utmTerm: {
      type: "string",
      label: "UTM Term",
      description: "The UTM term of the person registering for the session.",
      optional: true,
    },
    utmContent: {
      type: "string",
      label: "UTM Content",
      description: "The UTM content of the person registering for the session.",
      optional: true,
    },
  },
  methods: {
    mapFields(fields = {}) {
      return Object.entries(fields)
        .reduce((acc, [
          id,
          value,
        ]) => !value
          ? acc
          : acc.concat({
            id,
            value,
          }), []);
    },
    registerSomeoneForSession({
      sessionId, ...args
    } = {}) {
      return this.app.post({
        path: `/sessions/${sessionId}/people`,
        ...args,
      });
    },
  },
  async additionalProps() {
    const { sessionId } = this;

    const { data: { attributes: { event_id: eventId } } } =
      await this.app.getSession({
        sessionId,
      });

    const { data: { attributes: { fields } } } =
      await this.app.getEvent({
        eventId,
      });

    return fields.reduce((acc, {
      type, id, required,
    }) => {
      if (type !== "text") {
        return acc;
      }
      const label = utils.snakeCaseToTileCase(id);
      return {
        ...acc,
        [id]: {
          type: "string",
          label,
          description: `The **${label}** of the person registering for the session.`,
          optional: !required,
        },
      };
    }, {});
  },
  async run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      sessionId,
      referrer,
      utmSource,
      utmMedium,
      utmCampaign,
      utmTerm,
      utmContent,
      ...fields
    } = this;

    const response = await this.registerSomeoneForSession({
      step,
      sessionId,
      data: {
        data: {
          type: "people",
          attributes: {
            referrer,
            utm_source: utmSource,
            utm_medium: utmMedium,
            utm_campaign: utmCampaign,
            utm_term: utmTerm,
            utm_content: utmContent,
            fields: this.mapFields(JSON.parse(JSON.stringify(fields))),
          },
        },
      },
    });

    step.export("$summary", `Successfully registered someone for session with ID ${response.data.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
Livestorm	`app`	`app`	This component uses the Livestorm app.
Session ID	`sessionId`	`string`	Select a value from the drop down menu.
Referrer	`referrer`	`string`	The referrer of the person registering for the session.
UTM Source	`utmSource`	`string`	The UTM source of the person registering for the session.
UTM Medium	`utmMedium`	`string`	The UTM medium of the person registering for the session.
UTM Campaign	`utmCampaign`	`string`	The UTM campaign of the person registering for the session.
UTM Term	`utmTerm`	`string`	The UTM term of the person registering for the session.
UTM Content	`utmContent`	`string`	The UTM content of the person registering for the session.

Action Authentication#

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

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

full:write

Register Someone For A Session with Livestorm API on New Image Impression from Hyperise API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular