← Zoom Admin

Recording Completed from Zoom Admin API

Pipedream makes it easy to connect APIs for Zoom Admin and 800+ other apps remarkably fast.

Trigger workflow on
Recording Completed from the Zoom Admin API
Next, do this
Connect to 800+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on Recording Completed with Zoom Admin API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Recording Completed trigger
    1. Connect your Zoom Admin account
    2. Configure zoomApphook
    3. Optional- Configure Include Audio Recordings
    4. Optional- Configure Include Chat Transcripts
  2. Add steps to connect to 800+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Recording Completed on Zoom Admin
Description:Emits an event each time a recording is ready for viewing in your Zoom account
Version:0.0.3
Key:zoom_admin-recording-completed

Code

/* eslint-disable camelcase */
import zoomAdmin from "../../zoom_admin.app.mjs";

export default {
  key: "zoom_admin-recording-completed",
  type: "source",
  name: "Recording Completed",
  description: "Emits an event each time a recording is ready for viewing in your Zoom account",
  version: "0.0.3",
  dedupe: "unique", // Dedupe events based on the ID of the recording file
  props: {
    zoomAdmin,
    zoomApphook: {
      type: "$.interface.apphook",
      appProp: "zoomAdmin",
      eventNames: [
        "recording.completed",
      ],
    },
    includeAudioRecordings: {
      type: "boolean",
      label: "Include Audio Recordings",
      description:
        "This source emits video (MP4) recordings only by default. Set this prop to `true` to include audio recordings",
      optional: true,
      default: false,
    },
    includeChatTranscripts: {
      type: "boolean",
      label: "Include Chat Transcripts",
      description:
        "This source emits video (MP4) recordings only by default. Set this prop to `true` to include chat transcripts",
      optional: true,
      default: false,
    },
  },
  async run(event) {
    if (event.event !== "recording.completed") {
      console.log("Not a recording.completed event. Exiting");
      return;
    }
    const {
      download_token,
      payload,
    } = event;
    const { object } = payload;
    const {
      recording_files,
      host_id,
      host_email,
    } = object;
    if (!recording_files || recording_files.length === 0) {
      console.log("No files in recording. Exiting");
      return;
    }

    for (const file of recording_files) {
      if (file.status !== "completed") continue;

      if (file.file_type === "M4A" && !this.includeAudioRecordings) {
        continue;
      }
      if (file.file_type === "CHAT" && !this.includeChatTranscripts) {
        continue;
      }

      this.$emit(
        {
          download_token,
          ...file,
          meeting_id_long: object.id, // Long ID is necessary for certain API operations
          meeting_topic: object.topic,
          host_id,
          host_email,
        },
        {
          summary: `${object.topic}${file.file_type}`,
          id: file.id,
          ts: +new Date(file.recording_end),
        },
      );
    }
  },
};

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.
LabelPropTypeDescription
Zoom AdminzoomAdminappThis component uses the Zoom Admin app.
zoomApphook$.interface.apphook
Include Audio RecordingsincludeAudioRecordingsboolean

This source emits video (MP4) recordings only by default. Set this prop to true to include audio recordings

Include Chat TranscriptsincludeChatTranscriptsboolean

This source emits video (MP4) recordings only by default. Set this prop to true to include chat transcripts

Authentication

Zoom Admin uses OAuth authentication. When you connect your Zoom Admin account, Pipedream will open a popup window where you can sign into Zoom Admin 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 Admin API.

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

About Zoom Admin

Video conferencing (includes account-level scopes)