The Zoom Admin API lets you harness the extensive capabilities of Zoom for automation and integration, right within Pipedream. Automate user management, track Zoom rooms, monitor webinars and meetings, and customize your workflow to respond dynamically to events like new participants or ended meetings. With these APIs and the power of Pipedream, you can streamline administrative tasks, extract valuable insights, and sync Zoom activities with other services.
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
zoom_admin: {
type: "app",
app: "zoom_admin",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://api.zoom.us/v2/users/me`,
headers: {
Authorization: `Bearer ${this.zoom_admin.$auth.oauth_access_token}`,
},
})
},
})
Automated User Provisioning and Deprovisioning: Sync user data from your HR platform (e.g., BambooHR) with Zoom. When a new employee is added in BambooHR, automatically create a Zoom user account for them. Conversely, when an employee leaves, trigger a workflow to deactivate their Zoom account.
Meeting Analytics and Reporting: Connect Zoom Admin with a data visualization tool like Tableau. Each time a meeting ends, aggregate meeting statistics and send them to Tableau to create real-time dashboards that help management analyze usage patterns and meeting effectiveness.
Webinar Attendee Follow-Up: Link Zoom webinars with email platforms such as SendGrid. After a webinar ends, send a customized follow-up email to all attendees with a survey or additional resources, and update your CRM (like Salesforce) with attendee engagement data.
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.
This directory contains event sources that operate on data from the Zoom API. These event sources work with the Zoom Admin app in Pipedream, specifically meant for Zoom admins operating on data across their account.
Event sources let you turn any API into an event stream. For example, the recording-completed.js
event source polls the Zoom API for new meeting or webinar recordings tied to your user, and emits a new event for every new recording it finds. You can access these events in real-time using a private SSE stream tied to your source, or in batch using the REST API. Or you can trigger Pipedream workflows on every new event.
You can trigger a Pipedream workflow — hosted Node.js code — on every new event from any Zoom source. You can find a few example workflows below.
To use a workflow, just Copy it and follow the instructions in the workflow's README
. You can modify or extend these workflows in any way you'd like.
For a deeper introduction to Pipedream and event sources, see the root README
in this repo, the component API, or the docs.
Emits an event each time a sub-account is created in your master account
Emits an event each time a meeting starts in your Zoom account
Emits an event each time your master account or sub-account profile is updated
Emits an event each time a recording is ready for viewing in your Zoom account
Register a participant for a meeting. See the docs here
Register a participant for a webinar. See the docs here
Zoom Admin uses OAuth authentication. When you connect your Zoom Admin account, Pipedream will open a popup window where you can sign into Zoom Admin 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 Admin API.
Pipedream requests the following authorization scopes when you connect your account:
GET
https://zoom.us/oauth/authorize
?
client_id={{oauth.client_id}}
&
redirect_uri={{oauth.redirect_uri}}
&
state={{oauth.state}}
&
response_type=code
&
scope={{oauth.space_separated_scopes}}
POST
https://zoom.us/oauth/token
content-type: application/x-www-form-urlencoded
accept: application/json
redirect_uri={{oauth.redirect_uri}}
&
grant_type=authorization_code
&
code={{oauth.code}}
POST
https://zoom.us/oauth/token
content-type: application/x-www-form-urlencoded
accept: application/json
grant_type=refresh_token
&
refresh_token={{oauth.refresh_token}}