Domain Statistics. with Short.io API on Custom Events from Zoom API

Pipedream makes it easy to connect APIs for Short.io, Zoom and 1,600+ other apps remarkably fast.

Trigger workflow on

Custom Events from the Zoom API

Next, do this

Domain Statistics. with the Short.io API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Zoom trigger and Short.io 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 Domain Statistics. action
1. Connect your Short.io account
2. Select a Domain Id
3. Optional- Select a Period
4. Optional- Select a Clicks Chart Interval
5. Optional- Configure Timezone offset
6. Optional- Configure Start date
7. Optional- Configure End date
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#

Domain Statistics. on Short.io

Description:Returns detailed statistics for domain in given period. [See the docs](https://developers.short.io/reference/getdomaindomainid).

Version:0.0.1

Key:short-domain-statistics

View on GitHub

Short.io Overview#

With the Short.io API, you can create powerful links for a variety of
use-cases. It is possible to shorten, brand, measure, and even monetize your
links.

Here is a list of uses for the Short.io API:

Shorten URLs – Create shortened URLs you can share on social media, web
pages, and other places where you want a clean, concise link.
Brand Links – Create SEO-friendly branded links with custom domains and
analytics tracking.
Measure Performance – Analyze ROI and user engagement via links in app
notifications, emails, SMS, etc.
Monetize Your Links – Monetize traffic with pay-per-click advertising links,
affiliate programs, and subscription services.
Automation – Automatically shorten URLs for SEO purposes, or for integrating
into other websites and services.
Track & Report – Get real-time statistics about link performance, as well as
performance on integrated services.
Security & Privacy – Secure your links with password protection and UTM
parameters to better protect your data.

Action Code#

import shortApp from "../../short.app.mjs";
import lodash from "lodash";

export default {
  key: "short-domain-statistics",
  name: "Domain Statistics.",
  description: "Returns detailed statistics for domain in given period. [See the docs](https://developers.short.io/reference/getdomaindomainid).",
  version: "0.0.1",
  type: "action",
  props: {
    shortApp,
    domainId: {
      propDefinition: [
        shortApp,
        "domainId",
      ],
    },
    period: {
      propDefinition: [
        shortApp,
        "period",
      ],
    },
    clicksChartInterval: {
      propDefinition: [
        shortApp,
        "clicksChartInterval",
      ],
    },
    tzOffset: {
      propDefinition: [
        shortApp,
        "tzOffset",
      ],
    },
    startDate: {
      propDefinition: [
        shortApp,
        "startDate",
      ],
    },
    endDate: {
      propDefinition: [
        shortApp,
        "endDate",
      ],
    },
  },
  async run({ $ }) {
    const param = lodash.pick(this, [
      "period",
      "clicksChartInterval",
      "tzOffset",
      "startDate",
      "endDate",
    ]);
    const statistics = await this.shortApp.getDomainStatistics($, this.domainId, param);
    $.export("$summary", `Successfully fetched domain statistics for: ${this.domainId}`);
    return statistics;
  },
};

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
Short.io	`shortApp`	`app`	This component uses the Short.io app.
Domain Id	`domainId`	`integer`	Select a value from the drop down menu.
Period	`period`	`string`	Select a value from the drop down menu:`totalcustomtodayyesterdayweekmonthlastmonthlast7last30`
Clicks Chart Interval	`clicksChartInterval`	`string`	Select a value from the drop down menu:`hourdayweekmonth`
Timezone offset	`tzOffset`	`integer`	Timezone offset, in minutes.
Start date	`startDate`	`string`	Returns statistics for clicks after given date, format: `yyyy-mm-dd`. Required if period is custom.
End date	`endDate`	`string`	Returns statistics for clicks before given date, format: `yyyy-mm-dd`. Required if period is custom.