Recording Completed (Instant) from Zoom API

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

Trigger workflow on

Recording Completed (Instant) from the Zoom API

Next, do this

Connect to 2,700+ APIs using code and no-code building blocks

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#

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

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
Add steps to connect to 2,700+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Message with Discord Webhook API on Recording Completed from Zoom API

Zoom + Discord Webhook

Try it

Get Film with SWAPI API on Recording Completed from Zoom API

Zoom + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on Recording Completed from Zoom API

Zoom + Airtable (API Key)

Try it

[Date/Time] Add/Subtract Time with Formatting API on Recording Completed (Instant) from Zoom API

Zoom + Formatting

Try it

Accept Completion with Sapling.ai API on Recording Completed (Instant) from Zoom API

Zoom + Sapling.ai

Try it

Details#

This is a pre-built, source-available 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 (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

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);
    }
  },
};

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`

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: