Skip to main content

Zoom Migration Guide

Upgrading to 2.0.0​

Risk of permanent data loss

Clearing a Full Refresh | Append stream permanently deletes destination history that Zoom can no longer serve, including reports older than roughly six months and meetings older than one year. Back up the affected tables before clearing.

Required scope for meeting report streams

Every connection syncing report_meetings or report_meeting_participants must add report:read:user:admin (granular) or report:read:admin (classic) to its Zoom app before upgrading. Most existing apps do not have this scope. OAuth connections must re-authenticate after adding it.

WHAT​

  • Primary keys are added or changed for meeting_polls ([meeting_id, id]), meeting_registration_questions ([meeting_id]), report_meetings ([uuid]), and report_meeting_participants ([meeting_uuid, user_id]). Webinar keys are webinar_panelists, webinar_registrants, and webinar_polls ([webinar_id, id]); webinar_registration_questions ([webinar_id]); report_webinars ([uuid]); and report_webinar_participants ([webinar_uuid, user_id]). meeting_poll_results, webinar_poll_results, and webinar_qna_results have no primary key because a result name is not unique.
  • webinar_id is an integer in webinar_panelists, webinar_registrants, webinar_polls, webinar_registration_questions, webinar_poll_results, and webinar_qna_results. The two result streams add the field, and webinar_tracking_sources.webinar_id changes from a string to an integer.
  • Timestamp fields now use the date-time schema format: users.created_at, users.user_created_at, and users.last_login_time; meetings and webinars created_at, start_time, occurrences[].start_time, and recurrence.end_date_time; meeting_registrants.create_time, webinar_registrants.create_time, and webinar_absentees.create_time; start_time and end_time in the meeting and webinar report streams; and join_time and leave_time in the meeting and webinar report participant streams.
  • The users stream adds login_types. The report_meeting_participants stream adds meeting_uuid and meeting_end_time; meeting_id remains the numeric meeting ID. Registration-question streams emit one record per meeting or webinar with questions nested in arrays, so their keys use the parent ID rather than a nested field_name.
  • Incremental sync is supported for meetings, report_meetings, report_meeting_participants, webinars, and report_user_meetings. report_webinars, report_webinar_participants, and report_daily use Full Refresh.
  • Incremental meetings and webinars use created_at with a 30-day lookback. Edits to meetings or webinars created before that window are not picked up by incremental sync; a Full Refresh picks them up.
  • meetings and webinars include only records created on or after start_date, including in Full Refresh. Leave start_date empty to sync everything Zoom still serves. report_user_meetings, report_daily, report_meetings, and report_meeting_participants start at start_date and are limited to Zoom's roughly six months of report retention; report_daily starts at the beginning of that month. report_webinars and report_webinar_participants are not filtered by start_date.

The poll-results question_details[].date_time fields remain unformatted because live Zoom values use YYYY-MM-DD HH:MM:SS, not ISO 8601. Update SQL, dbt models, and dashboards that treat the retyped timestamp columns or webinar_id as strings.

Report meeting streams​

report_meetings and report_meeting_participants now use Zoom's past-meetings report, which can return rows for eligible meeting sessions, including separate rows for sessions of recurring meetings. Zoom's past-meetings report omits sessions with fewer than two participants, so those sessions produce no report rows. Zoom retains these reports for roughly six months, and start_date further limits the requested report window.

Every connection syncing these streams must add the granular report:read:user:admin scope or the classic report:read:admin scope before upgrading. Most existing apps do not have this scope. Without it, syncs fail after the upgrade because the connection check does not test for it. OAuth connections must re-authenticate after adding the scope.

WHY​

Composite keys distinguish records that repeat across meetings or webinars, and typed timestamps make their date-time semantics explicit. Meeting report streams use session end times so a report is fetched when the session ends, even when the meeting was created much earlier.

WHO​

Users syncing users, meetings, meeting_registrants, meeting_polls, meeting_registration_questions, webinars, webinar_panelists, webinar_registrants, webinar_absentees, webinar_polls, webinar_poll_results, webinar_registration_questions, webinar_qna_results, webinar_tracking_sources, report_meetings, report_meeting_participants, report_webinars, or report_webinar_participants are affected.

Users syncing only chat_channels, meeting_poll_results, report_user_meetings, report_daily, or zoom_events are not affected by this upgrade.

STEPS​

  1. Add report:read:user:admin (or report:read:admin) to your Zoom app and, for OAuth, re-authenticate the source. Do this before upgrading if you sync report_meetings or report_meeting_participants.
  2. Upgrade the Zoom source to 2.0.0 and refresh the source schema.
  3. Switch report_meetings and report_meeting_participants to Incremental. Auto-upgraded connections remain on Full Refresh; Full Refresh makes one Heavy-rate-limited report request per past meeting session for roughly six months.
  4. For Full Refresh | Overwrite streams, no other action is needed; the next sync rebuilds the stream with the new schema. The exception is report_meetings and report_meeting_participants: their first 2.0.0 sync drops rows for sessions that ended more than about six months ago and for sessions with fewer than two participants, and 2.0.0 cannot sync those rows again. If you need them, back up these two tables before upgrading.
  5. For Full Refresh | Append streams, back up the destination first. Refresh the schema while retaining existing records, or leave the existing records in place and accept that old rows keep their previous types.
note

If you set start_date in source-zoom 1.5.0 for report_user_meetings or report_daily, meetings and webinars now include only records created on or after that date, including during Full Refresh. Clear start_date to keep everything Zoom still serves.

Upgrading to 1.1.0​

Authentication​

As of September 8, 2023, Zoom has deprecated JWT authentication and now supports Oauth instead.

Creating a server-to-server OAuth app​

To successfully migrate, please use Zoom's migration guide to create a new server-to-server OAuth app and generate the necessary credentials.

When creating the app, ensure you grant it access to the following scopes:

  • user:read:admin
  • meeting:read:admin
  • webinar:read:admin
  • chat_channel:read:admin
  • report:read:admin

To successfully authenticate your connection in Airbyte, you will need to input the following OAuth credentials:

  • client_id
  • client_secret
  • account_id
  • authorization_endpoint

Schema changes​

The type of the 'meeting_id' field in Meeting Registration Questions stream has been changed from "string" to "integer". Users with existing connections that are syncing data from this stream should refresh their schemas and reset their data.

Refresh affected schemas and reset data​

  1. Select Connections in the main nav bar.
    1. Select the connection affected by the update.
  2. Select the Replication tab.
    1. Select Refresh source schema.
    2. Select OK.
note

Any detected schema changes will be listed for your review.

  1. Select Save changes at the bottom of the page.
    1. Ensure the Reset affected streams option is checked.
note

Depending on destination type you may not be prompted to reset your data.

  1. Select Save connection.
note

This will reset the data in your destination and initiate a fresh sync.

For more information on resetting your data in Airbyte, see this page

Connector upgrade guide​

Review the following information to prepare for and execute your upgrade.

Review the changelog​

Before updating a connector, review the changelog to understand the changes and their potential impact on your existing connections. Find the changelog for any connector by navigating to the bottom of the documentation for that connector. Major version releases also include a migration guide.

Plan for major updates​

Major updates may require you to adjust connection settings or even make changes to your data pipelines. Allocate enough time and resources for this. Use the migration guide to ensure your transition process goes smoothly.

Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You always need to manually update for major version bumps.

Self-managed plans: pin a specific version if you can't update​

If you're unable to upgrade to the new version of a connector, you can pin that connector to a specific version.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Edit the entry for the connector you want to pin.

  3. Set the Default Version to the version you want to use.

Self-managed plans: update the local connector image​

If you self-manage Airbyte, you must manually update the connector image in your local registry before proceeding with the migration. Follow the steps below.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Find the connector you want to update in the list of connectors.

    note

    Airbyte lists two versions, the current in-use version and the latest version available.

  3. Click Change to update your OSS version to the latest available version.

Update the connector version​

Update each instance of the connector separately. If you have multiple instances of a connector, updating one doesn't affect the others.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Select the instance of the connector you wish to upgrade.

  3. Select Upgrade.

  4. Follow the prompt to confirm you are ready to upgrade to the new version.

Clear data from affected streams​

After upgrading a connector with a breaking change, you must refresh affected schemas and clear your data.

  1. In the nav bar, click Connections.

  2. Find the connection affected by the upgrade.

  3. Click the Schema tab.

  4. Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.

  5. Click OK.

  6. Click Save changes

  7. Clear the data for the streams affected by this upgrade.

Once the clear is complete, you can begin syncing your data again as usual.