Create Video Conference with SignalWire API on Recording Completed (Instant) from Zoom API

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

Trigger workflow on

Recording Completed (Instant) from the Zoom API

Next, do this

Create Video Conference with the SignalWire 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 SignalWire 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 Video Conference action
1. Connect your SignalWire account
2. Configure Name
3. Configure Display Name
4. Optional- Configure Join From
5. Optional- Configure Join Until
6. Optional- Select a Quality
7. Optional- Select a Layout
8. Optional- Select a Size
9. Optional- Configure Record On Start
10. Optional- Configure Enable Room Previews
11. Optional- Configure Enable Chat
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 Video Conference on SignalWire

Description:Creates a video conference on SignalWire. [See the documentation](https://developer.signalwire.com/rest/create-a-video-conference)

Version:0.0.1

Key:signalwire-create-video-conference

View on GitHub

SignalWire Overview#

The SignalWire API provides powerful communication capabilities, allowing developers to send and receive text messages, make voice calls, and manage telephony features programmatically. On Pipedream, you can leverage these functionalities to create serverless workflows that integrate with numerous apps and services. With Pipedream's easy-to-use interface and robust connectivity options, you can build automated processes that trigger from various events and perform actions using SignalWire without managing infrastructure.

Action Code#

import signalwire from "../../signalwire.app.mjs";

export default {
  key: "signalwire-create-video-conference",
  name: "Create Video Conference",
  description: "Creates a video conference on SignalWire. [See the documentation](https://developer.signalwire.com/rest/create-a-video-conference)",
  version: "0.0.1",
  type: "action",
  props: {
    signalwire,
    name: {
      propDefinition: [
        signalwire,
        "name",
      ],
    },
    displayName: {
      propDefinition: [
        signalwire,
        "displayName",
      ],
    },
    joinFrom: {
      propDefinition: [
        signalwire,
        "joinFrom",
      ],
    },
    joinUntil: {
      propDefinition: [
        signalwire,
        "joinUntil",
      ],
    },
    quality: {
      propDefinition: [
        signalwire,
        "quality",
      ],
    },
    layout: {
      propDefinition: [
        signalwire,
        "layout",
      ],
    },
    size: {
      propDefinition: [
        signalwire,
        "size",
      ],
    },
    recordOnStart: {
      propDefinition: [
        signalwire,
        "recordOnStart",
      ],
    },
    enableRoomPreviews: {
      propDefinition: [
        signalwire,
        "enableRoomPreviews",
      ],
    },
    enableChat: {
      propDefinition: [
        signalwire,
        "enableChat",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.signalwire.createVideoConference({
      data: {
        name: this.name,
        display_name: this.displayName,
        join_from: this.joinFrom,
        join_until: this.joinUntil,
        quality: this.quality,
        layout: this.layout,
        size: this.size,
        record_on_start: this.recordOnStart,
        enable_room_previews: this.enableRoomPreviews,
        enable_chat: this.enableChat,
      },
      $,
    });
    $.export("$summary", `Successfully created video conference: ${this.name}`);
    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
SignalWire	`signalwire`	`app`	This component uses the SignalWire app.
Name	`name`	`string`	A named unique identifier for the room. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.
Display Name	`displayName`	`string`	Display name of the video conference. Maximum of 200 characters.
Join From	`joinFrom`	`string`	Conference does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z.
Join Until	`joinUntil`	`string`	Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z.
Quality	`quality`	`string`	Select a value from the drop down menu:`720p1080p`
Layout	`layout`	`string`	Select a value from the drop down menu:`grid-responsivehighlight-1-responsivescreen-sharescreen-share-2full-screen`
Size	`size`	`string`	Select a value from the drop down menu:`smallmediumlarge`
Record On Start	`recordOnStart`	`boolean`	Specifies whether to start recording a Conference Session when one is started for this Conference
Enable Room Previews	`enableRoomPreviews`	`boolean`	Whether a video with a preview of the content of the conference is to be generated.
Enable Chat	`enableChat`	`boolean`	Enables group chat for all participants of the room.

Create Video Conference with SignalWire API on Recording Completed (Instant) from Zoom API

Pipedream makes it easy to connect APIs for SignalWire, 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