Skip to content

fix(docs): update Zoom marketplace app creation steps#29758

Open
akshitj11 wants to merge 3 commits into
calcom:mainfrom
akshitj11:fix/docs-update-zoom-instructions-16193
Open

fix(docs): update Zoom marketplace app creation steps#29758
akshitj11 wants to merge 3 commits into
calcom:mainfrom
akshitj11:fix/docs-update-zoom-instructions-16193

Conversation

@akshitj11

@akshitj11 akshitj11 commented Jul 13, 2026

Copy link
Copy Markdown

What does this PR do?

Zoom Marketplace updated the General App creation flow. The previous docs referenced an OAuth-only path, listed bare env var names without example values, and did not explain when Development vs Production credentials apply.

This PR updates the Zoom setup guide for the current marketplace UI and clarifies that Development credentials work for the app owner's Zoom account, with Production required for external users.

  • Fixes (bug) Zoom App creation instructions out of date #16193
  • Updates apps/docs/content/apps/zoom.mdx for General App, Development credentials, scopes, and optional local install skip
  • Updates the matching section in README.md
  • Addresses CodeRabbit feedback on .env placeholder format and Development credential scope

Visual Demo (For contributors especially)

A visual demonstration is strongly recommended, for both the original and new change (video / image - any one).

Video Demo (if applicable):

  • N/A — documentation-only change.

Image Demo (if applicable):

  • Compare the updated steps in apps/docs/content/apps/zoom.mdx against the Zoom Marketplace General App → Development credentials screen.
  • Verify the .env example shows ZOOM_CLIENT_ID=your_zoom_client_id style assignments.

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works. (N/A — docs-only change.)

How should this be tested?

  • Are there environment variables that should be set?
    • No env vars required to review this PR. The docs describe ZOOM_CLIENT_ID and ZOOM_CLIENT_SECRET.
  • What are the minimal test data to have?
  • What is expected (happy path) to have (input and output)?
    • Input: follow the updated docs to create a General App and copy Development credentials.
    • Output: credentials can be added to .env and Zoom connects from Settings → Conferencing apps for users on the app owner's Zoom account.
  • Any other important info that could help to test that PR
    1. Read apps/docs/content/apps/zoom.mdx and the README Zoom section.
    2. Walk through Zoom Marketplace UI and confirm step order, scopes (meeting:write:meeting, user:read:settings), and Development credential guidance match the live UI.

Align Zoom setup docs with the current General App flow (Development
credentials, scopes, optional local install) so self-hosted users can
connect Zoom without outdated marketplace steps.

Fixes calcom#16193
@github-actions

Copy link
Copy Markdown
Contributor

Welcome to Cal.diy, @akshitj11! Thanks for opening this pull request.

A few things to keep in mind:

  • This is Cal.diy, not Cal.com. Cal.diy is a community-driven, fully open-source fork of Cal.com licensed under MIT. Your changes here will be part of Cal.diy — they will not be deployed to the Cal.com production app.
  • Please review our Contributing Guidelines if you haven't already.
  • Make sure your PR title follows the Conventional Commits format.

A maintainer will review your PR soon. Thanks for contributing!

@github-actions github-actions Bot added docs area: docs, documentation, cal.com/docs Low priority Created by Linear-GitHub Sync 🐛 bug Something isn't working labels Jul 13, 2026
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated Zoom setup documentation in the README and docs site. The instructions now cover creating a development General App, configuring environment variables and OAuth redirect settings, enabling allow-list and subdomain checks, selecting meeting:write:meeting and user:read:settings scopes, skipping unnecessary production activation or local installation steps, and restarting Cal.diy before connecting Zoom.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The docs now cover General app selection, Development credentials, redirect URL, subdomain, scopes, and self-hosted connection steps as requested.
Out of Scope Changes check ✅ Passed The PR appears limited to the Zoom docs update and matching README edits, with no unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the doc update for Zoom marketplace app creation steps.
Description check ✅ Passed The description matches the changes, describing the Zoom doc updates, credential guidance, and scope changes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/docs/content/apps/zoom.mdx`:
- Around line 20-22: Update the environment-variable example in the Zoom
documentation to show valid .env assignments for ZOOM_CLIENT_ID and
ZOOM_CLIENT_SECRET, using non-sensitive placeholder values rather than bare
variable names.

In `@README.md`:
- Line 716: Update the self-hosted Cal.diy Zoom credential guidance to clarify
that Development-app credentials only work for users in the app owner’s Zoom
account unless external sharing is approved. Either narrow the instruction to
developer-account-only deployments or add the required Production activation and
app marketplace publishing path for external users.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e378e207-4f4a-45c7-b45d-100296afbb5e

📥 Commits

Reviewing files that changed from the base of the PR and between f004349 and 3a34a87.

📒 Files selected for processing (2)
  • README.md
  • apps/docs/content/apps/zoom.mdx

Comment thread apps/docs/content/apps/zoom.mdx Outdated
Comment thread README.md Outdated
Address CodeRabbit feedback with valid .env placeholder assignments and
note that Development credentials only cover the app owner's Zoom account.
@akshitj11

akshitj11 commented Jul 13, 2026

Copy link
Copy Markdown
Author

Addressed CodeRabbit feedback ,updated .env placeholder format and clarified Development vs Production credential scope.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 718-721: Specify the fenced-block language for the Zoom
environment-variable example by adding dotenv (or bash) to the opening Markdown
fence, while leaving the ZOOM_CLIENT_ID and ZOOM_CLIENT_SECRET contents
unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cf3bac30-b453-484d-9a1d-92d62c29c6af

📥 Commits

Reviewing files that changed from the base of the PR and between 3a34a87 and 6576b00.

📒 Files selected for processing (2)
  • README.md
  • apps/docs/content/apps/zoom.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/apps/zoom.mdx

Comment thread README.md Outdated
@akshitj11

Copy link
Copy Markdown
Author

CodeRabbit fixes pushed. Please add the run-ci label. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🐛 bug Something isn't working docs area: docs, documentation, cal.com/docs Low priority Created by Linear-GitHub Sync size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(bug) Zoom App creation instructions out of date

1 participant