Zoom Integration
Updated 04-29-26 - V: 1.0.0
Ubaid A
Last Update il y a 2 mois
This guide walks you through connecting your Zoom account to FXMedSupport, including creating a Server-to-Server OAuth app in Zoom, adding your credentials, and configuring notifications, settings, resource mapping, and tags mapping.
The Zoom Integration inside FXMedSupport allows your practice to connect Zoom accounts to Cerbo, automatically generate Zoom meeting links for virtual appointments, send branded appointment notifications and reminders, enable Zoom meeting transcripts, map Cerbo resources to specific Zoom accounts, assign patient tags on meeting registration and join, and join meetings directly from inside the app. The integration is powered by a Zoom Server-to-Server OAuth app that you create inside the Zoom App Marketplace.
What It Supports
• Automatically generate Zoom meeting links for virtual appointment types
• Send customizable appointment confirmation notifications via Portal Message, Email, Push Notification, or SMS
• Configure default and additional appointment reminders with custom timing and channels
• Enable Zoom meeting transcript sub-account creation
• Enable plain encounter creation if Auto Encounter does not fire
• Map each Cerbo resource to a specific Zoom account for scheduling
• Auto-assign Cerbo tags when patients register for or join a Zoom meeting
• Join Zoom meetings directly from inside FXMedSupport
Before You Begin
• You must have admin access to your Zoom account
• A Zoom Pro or higher plan is required to use Server-to-Server OAuth apps
• You will need to create a Server-to-Server OAuth app inside the Zoom App Marketplace — have your Zoom admin login credentials ready
• All Cerbo resources that need Zoom mapping must already be set up in Cerbo before configuring resource mapping
Step 1: Open the FXMedSupport Widget
1. On the right side of the Cerbo screen, click the FXMedSupport circular icon to open the widget.
Step 2: Navigate to Zoom Integration
2. Scroll to the Scheduling section and locate Zoom Integration. It is listed as Button 1.
3. Click Zoom Integration to open the app.
4. The app opens with the following tabs across the top: Zoom Notifications, Zoom Settings, Zoom Accounts Linked, Zoom Resource Mapping, Zoom Tags Mapping, and Join Meeting.
Step 3: Create a Server-to-Server OAuth App in Zoom
1. Go to zoom.com and sign in to your Zoom account.
2. Click your profile avatar in the top-right corner and select Settings from the dropdown menu.
4. In the Zoom App Marketplace, click the Develop button in the top-right corner.
7. Click Create.
Example: Fx med integration
9. Click Create.
ℹ️ Info: The Server-to-Server OAuth app type allows FXMedSupport to access your Zoom account data (meetings, recordings, users) without requiring individual user logins. This is the required app type for this integration.
Step 4: Copy Your App Credentials from Zoom
2. Copy the Account ID by clicking the Copy button next to it. Save this value — you will paste it into FXMedSupport.
3. Copy the Client ID by clicking the Copy button next to it. Save this value.
4. Copy the Client Secret by clicking the Copy button next to it. Save this value.
5. Click Continue to proceed to the next step.
⚠️ Warning: Store your Account ID, Client ID, and Client Secret securely. Do not share them publicly or in unsecured documents. These credentials give full API access to your Zoom account.
Step 5: Fill In App Information
• App Name — this is pre-filled with the name you entered when creating the app.
• Short Description — enter a brief 1–2 sentence description of what the app does.
Example: "We are providing app for clinics"
• Company Name — enter your practice or company name.
Example: "FX Med Support Integration"
2. Scroll down to the Developer Contact Information section and fill in:
• Name — enter a developer contact name.
• Email — enter a corporate email address for API update notifications.
3. Click Continue. You will see a green "Saved" confirmation.
Step 6: Copy Your Secret Token
2. Copy the Secret Token by clicking the Copy button next to it. Save this value — you will paste it into FXMedSupport.
Note: This token is used by Zoom to verify event notifications sent to your app.
3. The Event Subscriptions toggle is optional — leave it off unless you need real-time webhook events.
4. Click Continue to proceed to the Scopes page.
Step 7: Add Required Scopes
1. On the Scopes page, click + Add Scopes.
2. In the Add Scopes dialog, click Meetings in the left Product list.
3. Add the following Meeting Scopes by searching and selecting each one:
meeting:read:meeting:admin, meeting:read:registrant:admin, meeting:read:participant:admin, meeting:write:registrant:admin, meeting:update:status:admin, meeting:update:meeting:admin, meeting:delete:meeting:admin, meeting:write:meeting:admin, meeting:write:registrant:master, meeting:write:meeting:master, meeting:read:meeting:master, meeting:read:participant:master, Meeting:read:registrant:master, Meeting:read:list_meetings:admin, Meeting:read:invitation:admin, Meeting:read:list_registrants:admin, meeting:read:meeting:admin
4. Click User in the left Product list.
5. Add the following User Scopes:
user:read:list_schedulers:admin, user:read:list_users:admin, user:read:token:admin, user:read:settings:admin, user:read:user:admin, user:read:email:admin, user:read:list_permissions:admin, user:read:list_permissions:master, user:read:user:master, user:read:list_users:master, user:read:token:master, user:read:settings:master, user:read:zak:admin, user:write:user:admin, user:delete:user:admin
6. Click Recording in the left Product list.
7. Click Select All, then choose Select All (All) from the sub-menu to select all 48 recording scopes.
8. Click Done.
9. In the Scope description field, enter a brief description of how this data will be used.
Example: "Want to pull recording for training purpose"
10. Click Continue.
💡 Tip: Use the search box inside the Add Scopes dialog to quickly find individual scope names instead of scrolling through the full list.
Step 8: Complete Developer Contact and Activate Your App
5. Your app is now active and ready to connect to FXMedSupport.
ℹ️ Info: Once activated, your app screen will show "Your app is activated on the account" with a green checkmark. A Deactivate your app button will also appear if you ever need to disable the connection.
Step 9: Add Your Zoom Account in FXMedSupport
1. Click the Zoom Accounts Linked tab at the top of the Zoom Integration app.
2. Click the Add Zoom User button.
3. The "Add a new Zoom Account" form opens. Fill in the following fields:
• Email — enter the email address of the Zoom account.
• Zoom Password — enter the password for the Zoom account.
• Name — enter the name of the doctor or provider for this practice.
• Is Master Account? — check this box if this is the master Zoom account (the account that created the users and has the JWT app credentials).
4. When Is Master Account? is checked, the following additional fields will appear. Fill them in with the credentials you copied from Zoom:
• Account Id — paste the Account ID copied from the Zoom App Credentials page.
• Client Id — paste the Client ID copied from the Zoom App Credentials page.
• Client Secret — paste the Client Secret copied from the Zoom App Credentials page.
• Webhook — leave blank unless you have a specific webhook URL to configure.
• Secret Token — paste the Secret Token copied from the Zoom Feature page.
• Select Cerbo User — select the Cerbo user account to associate with this Zoom account.
5. Click Submit to save the account.
6. The account will appear in the Zoom Accounts list showing Name, Email, Account Id (masked), Client Id (masked), and Client Secret (masked), along with action icons.
💡 Tip: If you have additional Zoom accounts to connect (e.g., for sub-providers or test accounts), click Add Zoom User again and repeat this step for each account. Leave "Is Master Account?" unchecked for non-master accounts and fill in Email, Zoom Password, and Name only.
Step 10: Configure Zoom Notifications
2. Review the available Placeholders you can use inside your notification messages:
{patientFirst}, {providerName}, {link}, {title}, {startDate}, {providerFirst}, {providerLast}
3. Fill in the Notification Subject field with the subject line for appointment confirmation notifications.
Example: "Thank you for scheduling a virtual appointment"
4. Fill in the Notification Body field with the full message body. Use placeholders to personalize it.
Example: "{patientFirst}, Thank you for scheduling a virtual appointment with {providerName}. Your appointment {title} will be held virtually over Zoom on {startDate}. To join your appointment, please click on this link: {link}. If you have any questions, please contact our office."
• Push Notification
• Portal Message
• SMS
• Time To Send Reminder Notification — enter the number of hours before the appointment to send the reminder (e.g., 10 for 10 hours before, 24 for 24 hours before).
• Reminder Notification Subject — enter the subject for the reminder message.
• Reminder Notification Body — enter the body text for the reminder. Placeholders can be used here as well.
• Reminder Notification Send Channel — select the channel for this reminder (Email, Push Notification, Portal Message, or SMS).
8. To remove an additional reminder, click the red trash icon next to it.
9. Optionally check Disable Reminder Email to suppress email reminders.
10. Click Submit to save all notification settings.
ℹ️ Info: You can set multiple reminders at different time intervals. For example, one reminder 24 hours before via Email and another 1 hour before via SMS. Each reminder can use a different channel.
Step 11: Configure Zoom Settings
2. Under Zoom Link Type, choose how Zoom meeting links are generated:
• Keyword — check this option to trigger Zoom link generation based on a keyword in the appointment.
• Appointment Types — check this option to generate Zoom links for specific appointment types. This is the recommended option.
4. Under Zoom Transcript Setting, check Enable Zoom Transcript Sub Account Creation to enable automatic meeting transcript creation for your Zoom sub-accounts.
5. Under Enable Plain Encounter Creation, check Create plain encounter if auto encounter does not create. When enabled, if the Auto Encounter app does not create an encounter automatically after a Zoom meeting, a plain encounter will be created instead and will appear in the patient portal queue.
6. Click Save to save all Zoom settings.
Step 12: Configure Zoom Resource Mapping
1. Click the Zoom Resource Mapping tab at the top of the Zoom Integration app.
2. Check the Enable Zoom Resource Mapping? checkbox to activate resource mapping.
3. A list of all your Cerbo Resources will appear on the left, with a Mapping dropdown on the right for each one.
4. For each Cerbo Resource, click its Mapping dropdown and select the Zoom account (email address) that should be used for meetings booked under that resource.
Example: Nutrition → mackey@fxmedsupport.com
Example: Lets Connect → rebecca@fxmedsupport.com
Example: Future Labs → Select Zoom Account (leave unassigned if not needed)
6. Click Save Changes when finished.
💡 Tip: If a resource does not need a Zoom account assigned (e.g., in-person-only resources), leave its mapping set to "Select Zoom Account." Only resources that host virtual appointments need to be mapped.
Step 13: Configure Zoom Tags Mapping
1. Click the Zoom Tags Mapping tab at the top of the Zoom Integration app.
2. Check the Enable Tags Mapping? checkbox to activate tags mapping.
3. Under Meeting Register, click inside the tag field and select the tags you want automatically assigned to patients who register for a Zoom meeting.
4. Under Meeting Join, click inside the tag field and select the tags you want automatically assigned to patients who actually join a Zoom meeting.
5. Click Save Changes when finished.
ℹ️ Info: Meeting Register tags are applied when a patient registers/books a Zoom appointment. Meeting Join tags are applied when the patient actually clicks the link and joins the call. These can be used to trigger automations or track attendance in Cerbo.
Step 14: Join a Meeting Directly (Optional)
2. In the Enter meeting link field, paste a Zoom meeting URL.
3. Click the JOIN MEETING button to join the meeting directly from inside FXMedSupport.
Summary
App Credentials (Account ID, Client ID, Client Secret) copied from the Zoom App Credentials page.
App Information completed with App Name, Short Description, Company Name, and Developer Contact Name and Email.
Secret Token copied from the Feature page.
Required Scopes added: Meeting Scopes (17), User Scopes (15), and all Recording Scopes (48) with a scope description entered.
App activated via the Activate your app button on the Activation page.
Zoom Account added in FXMedSupport via Zoom Accounts Linked > Add Zoom User, with Is Master Account? checked and all credentials entered.
Zoom Notifications configured with Subject, Body (using placeholders), Send Channel, and one or more Reminder entries.
Zoom Settings configured with Appointment Types selected, Zoom Transcript enabled, and Plain Encounter Creation enabled.
Zoom Resource Mapping enabled and each Cerbo resource mapped to the correct Zoom account, then Save Changes clicked.
Zoom Tags Mapping enabled with Meeting Register and Meeting Join tags assigned, then Save Changes clicked.
Troubleshooting
App cannot be activated in Zoom → Click the red links on the Activation page to identify which required fields are missing. Typically this is the Developer Contact Name and Developer Contact Email on the Information page. Fill those in and return to the Activation tab.
Zoom meeting links are not being generated for appointments → Verify that Appointment Types is selected under Zoom Link Type in Zoom Settings, and that the correct appointment types are added to the Select Appointment Types field. Click Save after any changes.
Notifications are not being sent to patients → Confirm that the Notification Send Channel is set and that Submit was clicked on the Zoom Notifications tab. Also verify the patient has a valid email address or portal account depending on the channel selected.
Reminder is not sending at the correct time → Check the Time To Send Reminder Notification field. This value is in hours before the appointment. Ensure it is a whole number and that Submit was clicked to save.
Resource mapping is not working → Confirm the Enable Zoom Resource Mapping? checkbox is checked and that Save Changes was clicked after assigning accounts to resources. Also verify the Zoom account used is an active connected account in the Zoom Accounts Linked tab.
Tags are not being applied when patients register or join → Confirm Enable Tags Mapping? is checked on the Zoom Tags Mapping tab and that Save Changes was clicked. Also verify the tags selected exist in Cerbo.
Need Help?
If you run into any issues while setting up or configuring the Zoom Integration, please reach out to our support team. We're happy to help!