Zoom Migration Guide
Upgrading to 2.0.0
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.
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]), andreport_meeting_participants([meeting_uuid, user_id]). Webinar keys arewebinar_panelists,webinar_registrants, andwebinar_polls([webinar_id, id]);webinar_registration_questions([webinar_id]);report_webinars([uuid]); andreport_webinar_participants([webinar_uuid, user_id]).meeting_poll_results,webinar_poll_results, andwebinar_qna_resultshave no primary key because a result name is not unique. webinar_idis an integer inwebinar_panelists,webinar_registrants,webinar_polls,webinar_registration_questions,webinar_poll_results, andwebinar_qna_results. The two result streams add the field, andwebinar_tracking_sources.webinar_idchanges from a string to an integer.- Timestamp fields now use the
date-timeschema format:users.created_at,users.user_created_at, andusers.last_login_time;meetingsandwebinarscreated_at,start_time,occurrences[].start_time, andrecurrence.end_date_time;meeting_registrants.create_time,webinar_registrants.create_time, andwebinar_absentees.create_time;start_timeandend_timein the meeting and webinar report streams; andjoin_timeandleave_timein the meeting and webinar report participant streams. - The
usersstream addslogin_types. Thereport_meeting_participantsstream addsmeeting_uuidandmeeting_end_time;meeting_idremains 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 nestedfield_name. - Incremental sync is supported for
meetings,report_meetings,report_meeting_participants,webinars, andreport_user_meetings.report_webinars,report_webinar_participants, andreport_dailyuse Full Refresh. - Incremental
meetingsandwebinarsusecreated_atwith 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. meetingsandwebinarsinclude only records created on or afterstart_date, including in Full Refresh. Leavestart_dateempty to sync everything Zoom still serves.report_user_meetings,report_daily,report_meetings, andreport_meeting_participantsstart atstart_dateand are limited to Zoom's roughly six months of report retention;report_dailystarts at the beginning of that month.report_webinarsandreport_webinar_participantsare not filtered bystart_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
- Add
report:read:user:admin(orreport:read:admin) to your Zoom app and, for OAuth, re-authenticate the source. Do this before upgrading if you syncreport_meetingsorreport_meeting_participants. - Upgrade the Zoom source to 2.0.0 and refresh the source schema.
- Switch
report_meetingsandreport_meeting_participantsto 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. - For Full Refresh | Overwrite streams, no other action is needed; the next sync rebuilds the stream with the new schema. The exception is
report_meetingsandreport_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. - 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.
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
- Select Connections in the main nav bar.
- Select the connection affected by the update.
- Select the Replication tab.
- Select Refresh source schema.
- Select OK.
Any detected schema changes will be listed for your review.
- Select Save changes at the bottom of the page.
- Ensure the Reset affected streams option is checked.
Depending on destination type you may not be prompted to reset your data.
- Select Save connection.
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.
-
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.
-
-
Edit the entry for the connector you want to pin.
-
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.
-
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.
-
-
Find the connector you want to update in the list of connectors.
noteAirbyte lists two versions, the current in-use version and the latest version available.
-
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.
-
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.
-
-
Select the instance of the connector you wish to upgrade.
-
Select Upgrade.
-
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.
-
In the nav bar, click Connections.
-
Find the connection affected by the upgrade.
-
Click the Schema tab.
-
Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.
-
Click OK.
-
Click Save changes
-
Clear the data for the streams affected by this upgrade.
Once the clear is complete, you can begin syncing your data again as usual.