← Zoom

Recording Completed from Zoom API

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

Trigger workflow on
Recording Completed from the Zoom API
Next, do this
Connect to 700+ 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 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 account
    2. Configure zoomApphook
    3. Optional- Select one or more Meeting Filter
    4. Optional- Configure Include Audio Recordings
    5. Optional- Configure Include Chat Transcripts
  2. Add steps to connect to 700+ 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
Description:Emits an event each time a new recording completes for a meeting or webinar where you're the host
Version:0.0.5
Key:zoom-recording-completed

Code

/* eslint-disable camelcase */
import axios from "axios";
import zoom from "../../zoom.app.mjs";

export default {
  key: "zoom-recording-completed",
  name: "Recording Completed",
  description:
    "Emits an event each time a new recording completes for a meeting or webinar where you're the host",
  version: "0.0.5",
  props: {
    zoom,
    zoomApphook: {
      type: "$.interface.apphook",
      appProp: "zoom",
      eventNames: [
        "recording.completed",
      ],
    },
    meetingIds: {
      type: "integer[]",
      label: "Meeting Filter",
      description: "Optionally filter for events for one or more meetings.",
      async options({ page }) {
        const data = await this.listMeetings(page);
        return data.meetings.map((meeting) => {
          return {
            label: `${meeting.topic} (${meeting.id})`,
            value: meeting.id,
          };
        });
      },
      optional: true,
    },
    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,
    },
  },
  methods: {
    async listMeetings({ page }) {
      const config = {
        method: "get",
        url: "https://api.zoom.us/v2//users/me/meetings",
        headers: {
          Authorization: `Bearer ${this.zoom.$auth.oauth_access_token}`,
        },
        params: {
          page_number: page + 1,
        },
      };
      return (await axios(config)).data;
    },
  },
  async run(event) {
    if (event.event !== "recording.completed") {
      console.log("Not a recording.completed event. Exiting");
      return;
    }
    const { payload } = event;
    const {
      object,
      download_token,
    } = payload;
    const {
      recording_files,
      host_id,
      host_email,
    } = object;
    if (!recording_files || recording_files.length === 0) {
      console.log("No files in recording. Exiting");
      return;
    }

    if (this.meetingIds && this.meetingIds.length > 0 && !this.meetingIds.includes(object.id)) {
      console.log("Meeting ID does not match the filter rules.");
      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_url_with_token: `${file.download_url}?access_token=${download_token}`,
          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
ZoomzoomappThis component uses the Zoom app.
zoomApphook$.interface.apphook
Meeting FiltermeetingIdsinteger[]Select a value from the drop down menu.
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 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.