Create Route with Mailgun API on Custom Events from Zoom API

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

Trigger workflow on

Custom Events from the Zoom API

Next, do this

Create Route with the Mailgun API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Zoom trigger and Mailgun action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Events trigger
1. Connect your Zoom account
2. Select one or more Zoom Events
3. Configure zoomApphook
Configure the Create Route action
1. Connect your Mailgun account
2. Configure Priority
3. Configure Description
4. Select a Filter On
5. Configure Filter Expression
6. Select a Action
7. Configure Action Expression
8. Configure Halt on error?
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#

Custom Events on Zoom

Description:Listen for any events tied to your Zoom user or resources you own

Version:0.0.4

Key:zoom-custom-events

View on GitHub

Zoom Overview#

Connecting Zoom to any app using Pipedream

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).

Getting Started

First, sign up for Pipedream at https://pipedream.com.
Visit https://pipedream.com/accounts.
Click the button labeled Click Here to Connect an App.
Search for "Zoom" and select either Zoom or Zoom Admin (see the differences below):

This will open up a new window prompting you to authorize Pipedream's access to your Zoom account. Once you authorize access, you should see your Zoom account listed among your apps.

Create a new workflow, add a new step, search for "Zoom" or "Zoom Admin". Once you've selected either app, you can choose to either "Run Node.js code" or select one of the prebuilt actions for performing common API operations.
At this stage, you'll be asked to link the Zoom account you connected above, authorizing the request to the Zoom API with your credentials:

Zoom vs Zoom Admin app

Zoom users can be classified into two groups: non-admins and admins. Admins have account-level permissions that users do not, and Zoom has corresponding admin-level scopes that aren't relevant for normal users. Therefore, Pipedream exposes two apps — Zoom and Zoom Admin — to serve the two groups.

In the Zoom Marketplace, these apps are named Pipedream, and Pipedream for Zoom Admins, respectively.

Non-admins have permissions to manage standard Zoom resources in their account: meetings, webinars, recordings, and more. If you're a non-admin, you'll want to use the Zoom app.

Zoom admins have permissions to manage account-level resources, like users and reports. They can also manage webinars and meetings across their organization. If you're an admin and need to manage these resources via API, you'll want to use the Zoom Admin app.

The Zoom API docs on permissions provide detailed information on these permissions and their associated OAuth scopes.

Trigger Code#

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

export default {
  key: "zoom-custom-events",
  name: "Custom Events",
  description:
    "Listen for any events tied to your Zoom user or resources you own",
  version: "0.0.4",
  props: {
    zoom,
    eventNameOptions: {
      label: "Zoom Events",
      type: "string[]",
      async options() {
        return [
          "meeting.alert",
          "meeting.created.by_me",
          "meeting.created.for_me",
          "meeting.updated",
          "meeting.deleted.by_me",
          "meeting.deleted.for_me",
          "meeting.started",
          "meeting.ended",
          "meeting.registration_created",
          "meeting.registration_approved",
          "meeting.registration_cancelled",
          "meeting.registration_denied",
          "meeting.sharing_started.host",
          "meeting.sharing_started.participant",
          "meeting.sharing_ended.host",
          "meeting.sharing_ended.participant",
          "meeting.participant_jbh_joined",
          "meeting.participant_jbh_waiting",
          "meeting.participant_joined",
          "meeting.participant_left",
          "meeting.participant_joined_waiting_room",
          "meeting.participant_admitted",
          "meeting.participant_put_in_waiting_room",
          "meeting.participant_left_waiting_room",
          "recording.started",
          "recording.paused",
          "recording.resumed",
          "recording.stopped",
          "recording.completed",
          "recording.trashed.by_me",
          "recording.trashed.for_me",
          "recording.deleted.by_me",
          "recording.deleted.for_me",
          "recording.recovered.by_me",
          "recording.recovered.for_me",
          "recording.transcript_completed",
          "recording.registration_created",
          "recording.registration_approved",
          "recording.registration_denied",
          "user.updated",
          "user.settings_updated",
          "user.signed_in",
          "user.signed_out",
          "webinar.created.by_me",
          "webinar.created.for_me",
          "webinar.updated",
          "webinar.started",
          "webinar.ended",
          "webinar.alert",
          "webinar.sharing_started.host",
          "webinar.sharing_started.participant",
          "webinar.sharing_ended",
          "webinar.registration_created",
          "webinar.registration_approved",
          "webinar.registration_denied",
          "webinar.registration_cancelled",
          "webinar.participant_joined",
          "webinar.participant_left",
        ];
      },
    },
    zoomApphook: {
      type: "$.interface.apphook",
      appProp: "zoom",
      async eventNames() {
        return this.eventNameOptions;
      },
    },
  },
  async run(event) {
    console.log(event);
    this.$emit(event, {
      summary: event.event,
    });
  },
};

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	`zoom`	`app`	This component uses the Zoom app.
Zoom Events	`eventNameOptions`	`string[]`	Select a value from the drop down menu.
	`zoomApphook`	`$.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 Route on Mailgun

Description:Create a new route. [See the docs here](https://documentation.mailgun.com/en/latest/api-routes.html#actions)

Version:0.0.2

Key:mailgun-create-route

View on GitHub

Mailgun Overview#

Mailgun allows you to send and receive emails using their API. With Mailgun,
you can build a variety of applications and services that can send or receive
emails. Here are a few examples of what you can build with Mailgun:

A simple email service that can send or receive emails
An email marketing service that can send mass emails
A notification service that can send emails when certain events occur
A task management service that can send emails when tasks are due
A customer support service that can send or receive emails from customers

Action Code#

import mailgun from "../../mailgun.app.mjs";
import common from "../common.mjs";

export default {
  key: "mailgun-create-route",
  name: "Create Route",
  description: "Create a new route. [See the docs here](https://documentation.mailgun.com/en/latest/api-routes.html#actions)",
  version: "0.0.2",
  type: "action",
  props: {
    mailgun,
    priority: {
      propDefinition: [
        mailgun,
        "priority",
      ],
    },
    description: {
      propDefinition: [
        mailgun,
        "description",
      ],
    },
    match: {
      type: "string",
      label: "Filter On",
      description: "For more information, see the [route filters API documentation]" +
        "(https://documentation.mailgun.com/en/latest/api-routes.html#filters)",
      options: [
        "recipient",
        "header",
        "catch_all",
      ],
    },
    matchExpression: {
      type: "string",
      label: "Filter Expression",
      description: "For the `recipient` filter, specify a regex expression like `.*@gmail.com`. " +
        "For the `header` filter, specify a header name followed by a colon followed by a regex, " +
        "like `subject:.*support`. For the `catch_all` filters, leave this blank.",
    },
    action: {
      type: "string",
      label: "Action",
      description: "The route action to execute when the route expression evaluates to True. For" +
        "more information, see the [route actions API documentation]" +
        "[https://documentation.mailgun.com/en/latest/api-routes.html#actions]",
      options: [
        "forward",
        "store",
        "stop",
      ],
    },
    action_expression: {
      type: "string",
      label: "Action Expression",
      description: "For the `forward` action, specify a destination email address or URL. " +
        "For the `store` action, (optionally) specify a webhook URL to notify. " +
        "For the `stop` action, leave this blank.",
    },
    ...common.props,
  },
  methods: {
    _expression (filter, expression) {
      switch (filter) {
      case "catch_all":
        return "catch_all()";
      case "recipient":
        return `match_recipient("${expression}")`;
      case "header": {
        let [
          header,
          headerExpression,
        ] = expression.split(":");
        if (Array.isArray(headerExpression)) {
          headerExpression = headerExpression.join(":");
        }
        return `match_header("${header}", "${headerExpression}")`;
      }
      default:
        throw new Error(`Unsupported filter: ${filter}`);
      }
    },
    _action (action, arg) {
      switch (action) {
      case "forward":
        return `forward("${arg}")`;
      case "store":
        if (arg.length > 0) {
          return `store(notify="${arg}")`;
        } else {
          return "store()";
        }
      case "stop":
        return "stop()";
      default:
        throw new Error(`Unsupported action: ${action}`);
      }
    },
    ...common.methods,
  },
  async run({ $ }) {
    const opts = {
      priority: this.priority,
      description: this.description,
      expression: this._expression(this.match, this.matchExpression),
      action: [
        this._action(this.action, this.action_expression),
      ],
    };
    const resp = await this.withErrorHandler(this.mailgun.createRoute, opts);
    $.export("$summary", "Successfully created route");
    return resp;
  },
};

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
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Priority	`priority`	`integer`	Priority ranks low to high, and higher priority routes are handled first
Description	`description`	`string`
Filter On	`match`	`string`	Select a value from the drop down menu:`recipientheadercatch_all`
Filter Expression	`matchExpression`	`string`	For the `recipient` filter, specify a regex expression like `.@gmail.com`. For the `header` filter, specify a header name followed by a colon followed by a regex, like `subject:.support`. For the `catch_all` filters, leave this blank.
Action	`action`	`string`	Select a value from the drop down menu:`forwardstorestop`
Action Expression	`action_expression`	`string`	For the `forward` action, specify a destination email address or URL. For the `store` action, (optionally) specify a webhook URL to notify. For the `stop` action, leave this blank.
Halt on error?	`haltOnError`	`boolean`

Action Authentication#

Mailgun uses API keys for authentication. When you connect your Mailgun account, Pipedream securely stores the keys so you can easily authenticate to Mailgun APIs in both code and no-code steps.

Get your API Key in the Control Panel, specifically in Settings > API Keys. More info in docs.

If your Mailgun account resides in the EU, choose the EU option in the Region field. Otherwise, choose the US (non-EU) region.