feat: Zoom Meeting support alongside Webinars by harshtandiya · Pull Request #17 · bwhtech/zoom_integration

harshtandiya · 2026-07-24T12:17:14Z

What

Adds first-class Zoom Meeting support next to the existing Webinar support, reusing shared API helpers instead of duplicating the Webinar controller — then generalises the shared doctypes so they describe what they actually hold.

Changes

api.py — resource-parameterized HTTP helpers (resource="meetings"|"webinars"): create / update / delete / add-registrant / paginated registrants & participants.
Zoom Meeting doctype + controller — create (type 2, approval_type:0 so registration works), update, delete, add_registrant, and sync_attendance (via past_meetings/{uuid}). Named by zoom_meeting_id, so the docname is the Zoom ID.
Session rename — Zoom Webinar Registration → Zoom Session Registration, Zoom Webinar Attendance Record → Zoom Session Attendance Record, Zoom Webinar Additional Param → Zoom Session Additional Param. They hold meeting rows as well as webinar rows now, so Webinar no longer belonged in the name.
Dynamic session reference — the registration and attendance doctypes dropped their separate webinar and meeting links for reference_doctype + reference_name. Picking the session collapses from a branch on which link is set to get_cached_doc(self.reference_doctype, self.reference_name), and reqd on both fields replaces the hand-written "exactly one of" guard.
Removed the unused Consolidated Webinar Attendance report (scaffolding that still returned Column 1 / Row 1).
Shared timezone list — the 135 zones Zoom accepts were duplicated byte for byte in both session forms (138 of the meeting script's 163 lines). Now public/js/zoom_timezones.js, loaded once via app_include_js.

Migrations

Patch	Stage	Does
`rename_webinar_doctypes_to_session`	`pre_model_sync`	Renames the three doctypes. Must precede the model sync or the new names exist as empty tables and the rename hits a clash.
`backfill_session_reference`	`post_model_sync`	Fills `reference_doctype` / `reference_name` from the legacy `webinar` / `meeting` columns. Fills empty references only — the legacy columns are not kept in step afterwards, so overwriting a set reference would undo a later rename.
`rename_meetings_to_zoom_id`	`post_model_sync`	Renames meetings created before ID-based naming, which kept a hash docname. `rename_doc` repoints `Buzz Event.zoom_meeting` and the dynamic `reference_name`.

Legacy webinar / meeting columns are left behind for bench trim-tables.

Fixes found while reviewing this branch

Three defects the tests were not catching, each now covered:

Fix	Was
Only PATCH Zoom when details changed	The guard compared a `datetime.date` to `str(date)`, never equal, so every save hit the API. Present in the webinar controller too, which the meeting one was copied from.
Scope webinar attendance to its own registrations	The lookup filtered on email alone. Harmless while one table held only webinars; wrong once it held meetings.
Keep access tokens out of request logs	`create_request_log` stores `request_headers` verbatim, so every logged call persisted its bearer token. Nothing in frappe or the `payments` app passes that argument — dropping it matches the convention.

Gotchas handled

Participant reports use the meeting UUID (captured at create), not the numeric id — URL-encoded; double-encode path noted inline for // UUIDs.
Registration requires settings.approval_type:0 on a scheduled (type 2) meeting — set in the create body and pinned by assertions.
Zoom returns int id; cast to string on store (Data field + URL paths).
link_filters on reference_doctype narrows the desk picker to the two session doctypes, but applies client-side only — validate_session_reference enforces it on the server.
Connections on Zoom Webinar now match reference_name. DocType Link has no dynamic filter field, so the panel no longer restricts by session type; both doctypes name from the same Zoom ID space, so a collision needs two sessions sharing an ID. Zoom Meeting gains the Connections it never had.

Required Zoom app scopes (Server-to-Server OAuth)

The app authenticates with grant_type=account_credentials, so these are account-level (:admin) granular scopes. Add them to the Zoom Marketplace app before merging — every call below 4711s without its scope. Webinar scopes already on the app are unchanged; these are purely additive.

Scope	Endpoint	Needed for	Required?
`meeting:write:meeting:admin`	`POST /users/me/meetings`	Creating the meeting on `Zoom Meeting` insert	Yes
`meeting:update:meeting:admin`	`PATCH /meetings/{meetingId}`	Pushing title/schedule edits back to Zoom	Yes
`meeting:delete:meeting:admin`	`DELETE /meetings/{meetingId}`	Deleting the meeting on `on_trash`	Yes
`meeting:write:registrant:admin`	`POST /meetings/{meetingId}/registrants`	Registering an attendee when a `Zoom Session Registration` is submitted	Yes
`meeting:read:list_past_participants:admin`	`GET /past_meetings/{meetingUUID}/participants`	`sync_attendance` — needs a Pro plan or higher	Yes
`meeting:read:list_registrants:admin`	`GET /meetings/{meetingId}/registrants`	`get_zoom_registrants` helper — no caller yet	Only for meeting-side registrant sync
`report:read:list_meeting_participants:admin`	`GET /report/meetings/{meetingId}/participants`	Not called — attendance uses `past_meetings`, which is gated by `meeting:read:list_past_participants:admin` instead	No
`meeting:read:meeting:admin`	`GET /meetings/{meetingId}`	Not called — nothing fetches a single meeting from Zoom	No

Scope names are as of the Zoom v2 granular scopes. Zoom renames these periodically — worth confirming each against the Marketplace UI when you add them.

Tests

All mocked — no real Zoom calls, and no live token fetch: Zoom Webinar calls requests and the token endpoint directly rather than going through api.py, so both are patched. Fixtures in tests/zoom_fixtures.py mirror live Zoom v2 JSON. 36 passing, ruff and pre-commit clean.

Session and registrant IDs are drawn fresh per call rather than fixed: sessions are named by Zoom ID and registrant_id is unique, and IntegrationTestCase rolls back per class rather than per test, so rows outlive a run and fixed IDs collided with their own leftovers on a rerun.

Three of these tests passed on their first run and had to be rewritten before they meant anything:

The unchanged-save test saved the doc returned by insert(), which still holds date as the string it was given, so the broken comparison matched by accident. It now reloads from the database, which is what the desk does.
The cross-session test relied on frappe.db.get_value ordering, which is undefined — it would have passed or failed at random. Rewritten so the correct answer is None.
The pagination test used two pages, and an implementation that appends the token still produces exactly one token on the second request. It takes three pages to see them stack, confirmed by writing the broken version and watching the third URL carry two.

Breaking changes

Renamed DocTypes

Before	After
`Zoom Webinar Registration`	`Zoom Session Registration`
`Zoom Webinar Attendance Record`	`Zoom Session Attendance Record`
`Zoom Webinar Additional Param`	`Zoom Session Additional Param`

Renamed fields

On both Zoom Session Registration and Zoom Session Attendance Record, the two links collapse into one dynamic pair:

Before	After
`webinar` (Link → Zoom Webinar)	`reference_doctype` = `"Zoom Webinar"`, `reference_name` = the old value
`meeting` (Link → Zoom Meeting)	`reference_doctype` = `"Zoom Meeting"`, `reference_name` = the old value

Also changed

Zoom Meeting docnames. Meetings are named by zoom_meeting_id now. Existing hash-named meetings are renamed by patch, so any docname you stored elsewhere is stale.
Removed: the unused Consolidated Webinar Attendance report.

What the patches fix for you

frappe.rename_doc repoints Link field options, Custom Field options, Property Setters, Dynamic Links, Report.ref_doctype, Client Script.dt and Notification.document_type. The backfill fills reference_doctype / reference_name from the old columns. The old columns stay until you run bench trim-tables, so nothing is lost if you need to check.

What you must fix by hand

Nothing rewrites code or expression bodies. Grep your custom app, Server Scripts, Client Scripts, Notification conditions, Print Formats and Jinja templates for the old names:

grep -rn "Zoom Webinar Registration\|Zoom Webinar Attendance Record\|Zoom Webinar Additional Param" .
grep -rnE "\b(webinar|meeting)\b.*Zoom Session" .

Then apply:

If your code does	Change it to
`frappe.get_all("Zoom Webinar Registration", ...)`	`frappe.get_all("Zoom Session Registration", ...)`
`filters={"webinar": w}`	`filters={"reference_doctype": "Zoom Webinar", "reference_name": w}`
`filters={"meeting": m}`	`filters={"reference_doctype": "Zoom Meeting", "reference_name": m}`
`doc.webinar` / `doc.meeting`	`doc.reference_name` (check `doc.reference_doctype` for which)
`from ...doctype.zoom_webinar_registration.zoom_webinar_registration import ZoomWebinarRegistration`	`from ...doctype.zoom_session_registration.zoom_session_registration import ZoomSessionRegistration`
`/api/resource/Zoom%20Webinar%20Registration`	`/api/resource/Zoom%20Session%20Registration`

Controller classes follow the same rename: ZoomWebinarAttendanceRecord → ZoomSessionAttendanceRecord, ZoomWebinarAdditionalParam → ZoomSessionAdditionalParam.

A row can only ever have one session, so webinar or meeting becomes just reference_name.

Pairs with bwhtech/buzz#288 — ship together, this app migrates first.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

greptile-apps