Subchapter 114.16
references/sdk-upgrade-guide.mdMarkdown4 KBView on GitHub
Guide for upgrading Meeting SDK and Video SDK versions.
For customer upgrades from older versions to latest, use:
References
App TypesBefore any upgrade, always check the official Zoom changelog:
If the above URL is unavailable or has moved, search for “zoom changelog” or “zoom developer changelog” to find the current location.
The changelog contains:
Zoom releases SDK updates regularly. This guide covers version policy and upgrade procedures.
# Check current version
npm list @zoom/meetingsdk
# Update to latest
npm update @zoom/meetingsdk
# Or specific version
npm install @zoom/meetingsdk@2.18.0When methods change signatures between versions:
// Old (v2.x)
client.join({
sdkKey: key,
sdkSecret: secret, // REMOVED in v3.x
meetingNumber: number
});
// New (v3.x) - signature generated server-side
client.join({
sdkKey: key,
signature: serverGeneratedSignature, // NEW
meetingNumber: number
});Action: Update to server-side signature generation for security.
| Old Method | New Method | Version |
|---|---|---|
ZoomMtg.init() | client.init() | Web SDK 3.x |
startVideo() | startVideo() + renderVideo() | Video SDK 1.8+ |
getMeetingUUID() | Use webhook payload | Meeting SDK 2.x |
Meeting SDK Web 3.x:
// Now requires explicit preload
import ZoomMtgEmbedded from '@zoom/meetingsdk/embedded';
const client = ZoomMtgEmbedded.createClient();
// Must init before join
await client.init({
zoomAppRoot: document.getElementById('root'),
language: 'en-US'
});Video SDK 1.8+:
// Video rendering is now two-step
await stream.startVideo();
await stream.renderVideo(
document.querySelector('#video-canvas'),
myUserId,
1280, 720, 0, 0, 3 // width, height, x, y, quality
);When upgrading major versions, check:
# Create upgrade branch
git checkout -b sdk-upgrade-v3
# Update package
npm install @zoom/meetingsdk@latest
# Run tests
npm test
# Test manually
# - Join meeting
# - Audio/video functionality
# - Screen sharing
# - Recording (if used)
# - Custom UI featuresNote for LLMs/Agents: If the changelog URLs return 404 or have moved, perform a web search for “zoom developer changelog” or “zoom sdk changelog” to find the current location. Zoom occasionally restructures their documentation.