The tap-zoom extractor pulls data from the Zoom API.

Getting Started

Prerequisites

If you haven’t already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

Using the Command Line Interface

  1. Add the tap-zoom extractor to your project using meltano add:

     meltano add extractor tap-zoom
    
  2. Configure the settings below using meltano config.

Using Meltano UI

  1. Start Meltano UI using meltano ui:

     meltano ui
    
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “Zoom”.
  4. Configure the settings below in the “Configuration” interface that opens automatically.

Next steps

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Settings

tap-zoom requires the configuration of the following settings:

In case of JSON Web Token authentication:

In case of OAuth authentication:

These and other supported settings are documented below. To quickly find the setting you’re looking for, use the Table of Contents in the sidebar.

Note that the Start Date is not available as the API does not support incremental replication. Zoom also appears to “expire” meetings and webinars over time, making them unavailable to the API. Make sure your data lands in a trusted destination, as it may be the only place it eventually becomes available.

Minimal configuration

A minimal configuration of tap-zoom in your meltano.yml project file will look like this:

plugins:
  extractors:
  - name: tap-zoom
    variant: mashey

Sensitive values are most appropriately stored in the environment or your project’s .env file:

export TAP_ZOOM_JWT=my_jwt

JSON Web Token

Your Zoom JSON Web Token. The JWT is likely the easiest option for tap users. Configure the JWT with a very long expiry so it does not expire.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-zoom set jwt <jwt>

export TAP_ZOOM_JWT=<jwt>

Client ID

Your Zoom Client ID - example from docs: 7lstjK9NTyett_oeXtFiEQ. See the Zoom OAuth App Credentials documentation for more information.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-zoom set zoom_client_id <client_id>

export TAP_ZOOM_CLIENT_ID=<client_id>

Client Secret

The Zoom Client Secret that is generated when app credentials are created. See the Zoom OAuth App Credentials documentation for more information.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-zoom set client_secret <client secret>

export TAP_ZOOM_CLIENT_SECRET=<client secret>

Refresh Token

The Zoom Refresh Token that is provided after successfully authenticating with Zoom. See the Zoom OAuth Access Token Request documentation for more information.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

```bash meltano config tap-zoom set refresh_token

export TAP_ZOOM_REFRESH_TOKEN=