Create Call with Hyros API on Recording Completed (Instant) from Zoom API

Pipedream makes it easy to connect APIs for Hyros, Zoom and 2,200+ other apps remarkably fast.

Trigger workflow on

Recording Completed (Instant) from the Zoom 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 Zoom 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 Recording Completed (Instant) trigger
1. Connect your Zoom account
2. Optional- Select one or more Meeting Filter
3. Optional- Configure Include Audio Recordings
4. Optional- Configure Include Chat Transcripts
5. Configure apphook
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#

Recording Completed (Instant) on Zoom

Description:Emit new event each time a new recording completes for a meeting or webinar where you're the host

Version:0.1.3

Key:zoom-recording-completed

View on GitHub

Zoom Overview#

The Zoom API lets you tap into a rich set of functionalities to enhance the video conferencing experience within your own app or workflow. With the Zoom API on Pipedream, you can automatically create meetings, manage users, send meeting notifications, and more, orchestrating these actions within a broader automation. This allows for seamless integration with other services, enabling both data collection and action triggers based on Zoom events.

Pipedream workflows allow you to run any Node.js code that connects to the Zoom API. Just create a new workflow, then add prebuilt Zoom actions (create a meeting, send a chat message, etc.) or write your own code. These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a Github PR, Zoom events, etc).

Trigger Code#

import common from "../common/common.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "zoom-recording-completed",
  name: "Recording Completed (Instant)",
  description: "Emit new event each time a new recording completes for a meeting or webinar where you're the host",
  version: "0.1.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    meetingIds: {
      type: "integer[]",
      label: "Meeting Filter",
      description: "Optionally filter for events for one or more meetings",
      propDefinition: [
        common.props.app,
        "meetingId",
      ],
    },
    includeAudioRecordings: {
      propDefinition: [
        common.props.app,
        "includeAudioRecordings",
      ],
    },
    includeChatTranscripts: {
      propDefinition: [
        common.props.app,
        "includeChatTranscripts",
      ],
    },
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    apphook: {
      type: "$.interface.apphook",
      appProp: "app",
      eventNames() {
        return [
          constants.CUSTOM_EVENT_TYPES.RECORDING_COMPLETED,
        ];
      },
    },
  },
  hooks: {
    async deploy() {
      const { meetings } = await this.app.listRecordings({
        params: {
          from: this.monthAgo(),
          to: new Date().toISOString()
            .slice(0, 10),
          page_size: 25,
        },
      });
      if (!meetings || meetings.length === 0) {
        return;
      }
      for (const meeting of meetings) {
        if (!this.isMeetingRelevant(meeting)) {
          continue;
        }
        for (const file of meeting.recording_files) {
          if (!this.isFileRelevant(file)) {
            continue;
          }
          this.emitEvent(file, meeting);
        }
      }
    },
  },
  methods: {
    ...common.methods,
    isMeetingRelevant(meeting) {
      const {
        id, recording_files,
      } = meeting;

      if (!recording_files || recording_files.length === 0) {
        console.log("No files in recording. Exiting");
        return false;
      }

      if (this.meetingIds && this.meetingIds.length > 0 && !this.meetingIds.includes(id)) {
        console.log("Meeting ID does not match the filter rules.");
        return false;
      }
      return true;
    },
    isFileRelevant(file) {
      return !((file.status !== "completed")
        || (file.file_type === "M4A" && !this.includeAudioRecordings)
        || (file.file_type === "CHAT" && !this.includeChatTranscripts));
    },
    emitEvent(file, meeting, downloadToken = null) {
      this.$emit(
        {
          download_url_with_token: `${file.download_url}?access_token=${downloadToken}`,
          download_token: downloadToken,
          ...file,
          meeting_id_long: meeting.id, // Long ID is necessary for certain API operations
          meeting_topic: meeting.topic,
          host_id: meeting.host_id,
          host_email: meeting.host_email,
        },
        {
          id: file.id,
          summary: `${meeting.topic} — ${file.file_type}`,
          ts: +new Date(file.recording_end),
        },
      );
    },
  },
  async run(event) {
    if (event.event !== constants.CUSTOM_EVENT_TYPES.RECORDING_COMPLETED) {
      console.log("Not a recording.completed event. Exiting");
      return;
    }
    const { payload } = event;
    const {
      object,
      download_token: downloadToken,
    } = payload;
    const { recording_files: recordingFiles } = object;

    if (!this.isMeetingRelevant(object)) {
      return;
    }

    for (const file of recordingFiles) {
      if (!this.isFileRelevant(file)) {
        continue;
      }

      this.emitEvent(file, object, downloadToken);
    }
  },
};

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
Zoom	`app`	`app`	This component uses the Zoom app.
Meeting Filter	`meetingIds`	`integer[]`	Select a value from the drop down menu.
Include Audio Recordings	`includeAudioRecordings`	`boolean`	This source emits video (MP4) recordings only by default. Set this prop to true to include audio recordings
Include Chat Transcripts	`includeChatTranscripts`	`boolean`	This source emits video (MP4) recordings only by default. Set this prop to `true` to include chat transcripts
	`apphook`	`$.interface.apphook`

Trigger Authentication#

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

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

About Zoom#

Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.

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.

Create Call with Hyros API on Recording Completed (Instant) from Zoom API

Pipedream makes it easy to connect APIs for Hyros, Zoom and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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