Create Call with Hyros API on New Event Triggered (Instant) from Hippo Video API

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

Trigger workflow on

New Event Triggered (Instant) from the Hippo Video API

Next, do this

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

Select this integration
Configure the New Event Triggered (Instant) trigger
1. Connect your Hippo Video account
2. Configure alert
3. Select one or more Event Ids
Configure the Create Call action
1. Connect your Hyros account
2. Configure Name
3. Optional- Configure Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Lead IPs
7. Optional- Configure Phone Numbers
8. Optional- Configure Id
9. Optional- Configure Date
10. Optional- Configure Qualified
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 Event Triggered (Instant) on Hippo Video

Description:Emit new event when any of the selected events are triggered.

Version:0.0.1

Key:hippo_video-new-triggered-event-instant

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.

Trigger Code#

import { v4 as uuidv4 } from "uuid";
import { EVENT_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import hippoVideo from "../../hippo_video.app.mjs";

export default {
  key: "hippo_video-new-triggered-event-instant",
  name: "New Event Triggered (Instant)",
  description: "Emit new event when any of the selected events are triggered.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    hippoVideo,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    alert: {
      type: "alert",
      alertType: "warning",
      content: "Please note that you can have only one webhook in your Hippo Video account, any change here will overwrite the current webhook configuration.",
    },
    eventIds: {
      type: "string[]",
      label: "Event Ids",
      description: "The Id of the events you want to be triggered.",
      options: EVENT_OPTIONS,
    },
  },
  methods: {
    removeHook() {
      this.hippoVideo.updateWebhook({
        data: {
          url: this.http.endpoint,
          secret_key: uuidv4(),
        },
      });
    },
  },
  hooks: {
    async activate() {
      await this.removeHook();
      await this.hippoVideo.updateWebhook({
        data: {
          events: parseObject(this.eventIds),
          url: this.http.endpoint,
          secret_key: uuidv4(),
        },
      });
    },
    async deactivate() {
      await this.removeHook();
    },
  },
  async run(event) {
    const { body } = event;
    const ts = Date.parse(body.eventTimestamp || new Date());

    this.$emit(body, {
      id: body.hook?.uuid || body.video_token,
      summary: `New event with event name: ${body.eventName || body.type} successfully triggered!`,
      ts: ts,
    });
  },
};

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
Hippo Video	`hippoVideo`	`app`	This component uses the Hippo Video app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Event Ids	`eventIds`	`string[]`	Select a value from the drop down menu:`{ "value": "3", "label": "Viewing Sessions" }{ "value": "1", "label": "Video Created" }{ "value": "4", "label": "CTA Lead Genaration" }{ "value": "5", "label": "CTA Annotations" }{ "value": "6", "label": "CT" }{ "value": "18", "label": "Video Transcode" }`

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

About Hippo Video#

The Only Interactive Video CX Platform You Ever Need to Create, Send & Track B2B Videos.

Action#

Create Call on Hyros

Description:Create a new call. [See the documentation](https://hyros.docs.apiary.io/#reference/0/calls/create)

Version:0.0.1

Key:hyros-create-call

View on GitHub

Hyros Overview#

The Hyros API offers the ability to track and analyze customer interactions across various marketing channels, aiming to improve ad tracking and ROI. Integrated within Pipedream, it allows for the automation of data collection, real-time analytics, and operational workflows. By leveraging Pipedream's serverless platform, developers can create workflows that respond to events from Hyros, trigger actions based on data insights, or synchronize data with other apps seamlessly.

Action Code#

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

export default {
  key: "hyros-create-call",
  name: "Create Call",
  version: "0.0.1",
  description: "Create a new call. [See the documentation](https://hyros.docs.apiary.io/#reference/0/calls/create)",
  type: "action",
  props: {
    hyros,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the call.",
    },
    email: {
      propDefinition: [
        hyros,
        "email",
      ],
      description: "Email associated with the lead that made the call.",
      optional: true,
    },
    firstName: {
      propDefinition: [
        hyros,
        "firstName",
      ],
      description: "First name of the lead that made the call.",
      optional: true,
    },
    lastName: {
      propDefinition: [
        hyros,
        "lastName",
      ],
      description: "Last name of the lead that made the call.",
      optional: true,
    },
    leadIps: {
      propDefinition: [
        hyros,
        "leadIps",
      ],
      description: "IPs of the customer that made the call. Will be used on the Ad attributing process.",
      optional: true,
    },
    phoneNumbers: {
      propDefinition: [
        hyros,
        "phoneNumbers",
      ],
      description: "Phone numbers of the lead that made the call. Will be used on the Ad attributing process.",
      optional: true,
    },
    id: {
      type: "string",
      label: "Id",
      description: "Identifier by which the call will be grouped. A default id will be assigned if it is not included.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Date on which the transaction was processed. The date must be written in accordance with [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). Format: YYYY-MM-DDThh:mm:ss",
      optional: true,
    },
    qualified: {
      type: "boolean",
      label: "Qualified",
      description: "A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      hyros,
      ...data
    } = this;

    let response;
    try {
      response = await hyros.createCall({
        $,
        data,
      });
    } catch ({ response }) {
      throw new ConfigurationError(response.data.message[0]);
    }

    $.export("$summary", `A new call with Id: ${response.request_id} was successfully created!`);
    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
Hyros	`hyros`	`app`	This component uses the Hyros app.
Name	`name`	`string`	The name of the call.
Email	`email`	`string`	Email associated with the lead that made the call.
First Name	`firstName`	`string`	First name of the lead that made the call.
Last Name	`lastName`	`string`	Last name of the lead that made the call.
Lead IPs	`leadIps`	`string[]`	IPs of the customer that made the call. Will be used on the Ad attributing process.
Phone Numbers	`phoneNumbers`	`string[]`	Phone numbers of the lead that made the call. Will be used on the Ad attributing process.
Id	`id`	`string`	Identifier by which the call will be grouped. A default id will be assigned if it is not included.
Date	`date`	`string`	Date on which the transaction was processed. The date must be written in accordance with ISO 8601 Format: YYYY-MM-DDThh:mm:ss
Qualified	`qualified`	`boolean`	A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.