Integrate Zoom

Deploy the Citrix integration for Zoom to schedule meetings from anywhere and from any device or intranet. With our Zoom microapp, every user can create a one-time or recurring meeting, add co-organizers, and select different time zones. The microapp also provides invitation details of the meeting that the user scheduled.

Note:

This integration template is in Preview and marked as Preview in the list of available templates that are shown in the product when adding a new integration. While in Preview, there is no commitment to support, and support is provided by the developer on a best-effort basis. Preview integration templates are shared for the purpose of testing and validation. We do not advise deploying them in production environments. For more information, see Maintenance statement for Microapps integration templates.

We want your feedback! Please provide feedback for this preview integration template as you use it. For any issues, our team will also monitor our dedicated forum on a daily basis.

For comprehensive details of the out-of-the-box microapp for Zoom, see Use microapps for Zoom.

Review prerequisites

These prerequisites assume that the administrator is part of the Zoom integration set up of the organization. This zoom admin account must have full read privileges for user information. After you set up this integration with Zoom, you will need these artifacts to add the integration in Citrix Workspace Microapps:

  • BASE URL: https://api.zoom.us/v2/
  • AUTHORIZATION URL: https://zoom.us/oauth/authorize
  • TOKEN URL: https://zoom.us/oauth/token
  • CLIENT ID: The client ID is the string representing client registration information unique to the authorization server.
  • SECRET: The client secret is a unique string issued when setting up the target application integration.

Note:

We recommend that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum-security compliance with your configured microapp.

Configure Citrix Gateway to support single sign-on for Zoom so that once users log in they are automatically logged in again without having to enter their credentials a second time. For more information about configuring SSO, see Citrix Gateway Service https://docs.citrix.com/en-us/citrix-gateway-service/.

The integration requires regular access to your Zoom instance, so we recommend creating a dedicated user account. You can view the permission/privileges at https://marketplace.zoom.us/docs/api-reference/other-references/privileges. This account must have the following permissions:

  • Permissions required for Service Account: Full administrator privileges

The number of API requests that can be made to specific resources is limited, we therefore recommend the following:

Create a new service account

Sign in here: https://zoom.us/signin. Refer to the below URL for new Service Accounts: https://marketplace.zoom.us/docs/guides/getting-started

Configure OAuth server

Configure the OAuth server to read data through the Zoom integration.

  1. Log in with your service account to: https://marketplace.zoom.us/.
  2. Select the Develop drop-down menu on the top right.
  3. Select Build App.
  4. Select Create for OAuth app, choose app-type as Account-Level App.
  5. Disable the toggle for publishing the app to marketplace and select Create.
  6. Enter the following authorized redirect URLs for this integration in the Redirect URL field and also the Whitelist URL field. Then select Continue.

    • https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  7. Complete the required fields then select Continue.
  8. Under the Scopes section, select Add Scopes and select the scopes for Meeting, Recording, and User. Then select Done.
  9. Select Install. A new tab opens to authorize the app then select Authorize and close the tab.
  10. Copy and save the ClientId and Secret shown on the screen. You use these details for Service Authentication while configuring the integration.

Configure OAuth client

Configure the OAuth client for writing back data through the Zoom integration.

  1. Log in with your service account, as above: https://marketplace.zoom.us/.
  2. Select the Develop drop-down menu on the top right.
  3. Select Build App.
  4. Select Create for OAuth app. Choose app-type as User-Managed App.
  5. Disable the toggle for publishing the app to marketplace and select Create.
  6. Enter the following authorized redirect URLs for this integration in the Redirect URL field and also the Whitelist URL field. Then select Continue.

    • <https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback>
  7. Complete the required fields then select Continue.
  8. Under the Scopes section, select Add Scopes and select the scopes for Meeting, Recording, and User. Then select Done.
  9. Select Install. A new tab opens to authorize the app then select Authorize and close the tab.
  10. Copy and save the ClientId and Secret shown on the screen. You use these details for Service Action Authentication while configuring the integration.

Add the integration to Citrix Workspace Microapps

Add the Zoom Meeting integration to Citrix Workspace Microapps to connect to your application. The authentication options are preselected. Ensure that these options are selected as you complete the process. This delivers out-of-the-box microapps with pre-configured notifications and actions which are ready to use within your Workspace.

Follow these steps:

  1. From the Microapp Integrations page, select Add New Integration, and Add a new integration from Citrix-provided templates.
  2. Choose the Zoom Meetings tile.
  3. Enter an Integration name for the integration.
  4. Enter Connector parameters.
    • Enter the instance Base URL: https://api.zoom.us/v2/
    • Select an Icon for the integration from the Icon Library, or leave this as the default icon.

    Name and Base URL

  5. Under Service authentication, select OAuth 2.0 from the Authentication method menu and complete the authentication details. The authentication options are preselected. Ensure that these options are selected as you complete the process. Use the OAuth 2.0 security protocol to generate request/authorization tokens for delegated access. It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum security compliance with your configured microapp.

    1. Select Authorization code from the Grant type menu. This grants a temporary code that the client exchanges for an access token. The code is obtained from the authorization server where you can see the information the client is requesting. Only this grant type enables secure user impersonation. This displays the Callback URL, which you use when registering your application.
    2. Select Authorization header from the Token authorization menu.
    3. The Authorization URL is prefilled: https://zoom.us/oauth/authorize
    4. The Token URL is prefilled: https://zoom.us/oauth/token
    5. Ensure the following is entered for Scope: account:write:adminDelete account:read:adminDelete account:masterDelete meeting:master meeting:read:adminDelete meeting:write:adminDelete recording:masterDelete recording:read:adminDelete recording:write:adminDelete user:masterDelete user:read:adminDelete user:write:adminDelete.
    6. Enter your Client ID. The client ID is the string representing client registration information unique to the authorization server. You collect this and the secret when you configured the OAuth server. You need to add the Callback URL you see on the integration configuration page.
    7. Enter your Client secret. The client secret is a unique string issued when setting up the target application integration.

    Service Authentication

  6. Under Service Action Authentication, enable the Use Separate User Authentication in Actions toggle. Service action authentication authenticates at the service action level. The authentication options are preselected. Ensure that these options are selected as you complete the process.

    1. Select OAuth 2.0 from the Authentication method menu and complete the authentication details.
    2. Select Authorization code from the Grant type menu. This grants a temporary code that the client exchanges for an access token. The code is obtained from the authorization server where you can see the information the client is requesting. Only this grant type enables secure user impersonation. This displays the Callback URL, which you use when registering your application.
    3. Select Authorization header from the Token authorization menu.
    4. The Authorization URL is prefilled: https://zoom.us/oauth/authorize
    5. The Token URL is prefilled: https://zoom.us/oauth/token
    6. Enter your Client ID. The client ID is the string representing client registration information unique to the authorization server. You collect this and the secret when you configured the OAuth client. You need to add the Callback URL you see on the integration configuration page.
    7. Enter your Client secret. The client secret is a unique string issued when setting up the target application integration.

    Service Action Authentication

  7. Enable the Enable request rate limiting toggle. Enter 55 for Number of requests and 1 second for Time interval.

    Rate limiting and logging toggles

  8. (Optional) Enable Logging toggle to keep 24 hours of logging for support purposes.
  9. Select Save to proceed.
  10. Under OAuth Authorization, select Authorize to log in with your service account. A pop-up appears with a Zoom login screen.
    1. Enter your Service Account user name and password and select Log in.
    2. Select Accept. Service Authentication

The Microapp Integrations page opens with your added integration and its microapps. From here, you can add another integration, continue setting up your out-of-the-box Microapps, or create a new microapp for this integration.

You are now ready to set and run your first data synchronization. As a large quantity of data can be pulled from your integrated application to the Microapps platform, we recommend you use the Table page to filter entities for your first data synchronization to speed up synchronization. For more information, see Verify needed entities. For complete information about synchronization rules, synchronization that does not meet its schedule and veto rules, see Synchronize data.

For more details of API endpoints and table entities, see Zoom HTTP connector specifications.

Use microapps for Zoom

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Create a Meeting: Schedule meetings according to your preference. User can choose the meeting title, duration, start date, co-organizers, and so forth.

Notification or Page Use-case workflows
Create a Meeting page Provides a form to schedule a meeting with the following details as per the user preference: Meeting Title, Start Time, Duration, Recurrence (once, daily, weekly, monthly), Password, Co-organizers, Dial-In Numbers for the meeting.
New Meetings One Time page This page provides the success message for the created meetings with a View Details button for the One-Time Meetings.
New Meetings Recurring page This page provides the success message for the created meetings with a View Detail button for the Recurring Meetings.
Invitations page Provides the invitation details for the meeting instantly after the meeting is created, such as Meeting Topic, Password, Calendar Details, Occurrences Details, Join URL, Start Time, Meeting Id, Dial-In Numbers.

Integrate Zoom