Integrate Webex

Deploy the Citrix Webex integration to schedule Webex Meetings from any device or intranet. Users can host one-time/recurring meetings, add invitees and co-hosts, and select from different timezones. The microapp also follows up with an email to the host and invitees with the corresponding meeting object for easy calendar integration.

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 a comprehensive list of out-of-the-box Webex microapps, see Use Webex microapps.

Review prerequisites

These prerequisites assume that administrator will be a part of the Webex integration set up of the organization. This Webex admin account must have full read privileges for user information.

After you set up this integration with Webex, you will need these artifacts to add the integration in Citrix Workspace Microapps, specifically the following list of parameters for setting up OAuth integration:

  • BASE URL: https://webexapis.com/v1/
  • AUTHORIZATION URL: https://webexapis.com/v1/authorize
  • TOKEN URL: https://webexapis.com/v1/access_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 Webex 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.

The integration requires regular access to your Webex instance, so we recommend creating a dedicated user account. This account must have the following permissions. You can view the permission/privileges using Webex Control Hub on .

  • 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:

Enable APIs

Webex APIs are enabled by default through web services for paid accounts.

Create a new service account

Sign up here: https://web.webex.com/. Refer to the below URL for new Service Accounts: https://help.webex.com/en-us/nkhozs6/Get-Started-with-Cisco-Webex-Control-Hub.

Configure OAuth server

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

  1. Log in with your service account to: https://developer.webex.com/docs/platform-introduction.
  2. Select the user name present on the top-right.
  3. Select My Webex Apps and select Create a New App.
  4. Select Create an Integration under the Integration tile.
  5. Complete the required fields and enter the following authorized redirect URLs for this integration in the Redirect URL field:

    • https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  6. Under Scopes section, select the spark:all and spark-admin:people_read check boxs.
  7. Select Add Integration after you complete all the required fields.
  8. 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 Webex integration.

  1. Log in with your service account, as above: https://developer.webex.com/docs/platform-introduction.
  2. Select the user name present on the top-right.
  3. Select My Webex Apps and select Create a New App.
  4. Select Create an Integration under the Integration tile.
  5. Complete the required fields and enter the following authorized redirect URLs for this integration in the Redirect URL field:

    • https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
  6. Under Scopes section, select the meeting:schedules_write check box.
  7. Select Add Integration after you complete all the required fields.
  8. 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 Webex 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 Webex Meetings tile.
  3. Enter an Integration name for the integration.
  4. Enter Connector parameters.
    • Enter the instance Base URL: https://webexapis.com/v1/.
    • 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 Request body from the Token authorization menu.
    3. The Authorization URL is prefilled: https://webexapis.com/v1/authorize
    4. The Token URL is prefilled: https://webexapis.com/v1/access_token
    5. Ensure the following is entered for Scope: spark:all spark-admin:people_read
    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 will display the Callback URL, which you use when registering your application.
    3. Select Request body from the Token authorization menu.
    4. The Authorization URL is prefilled: https://webexapis.com/v1/authorize
    5. The Token URL is prefilled: https://webexapis.com/v1/access_token
    6. Ensure the following is entered for Scope: meeting:schedules_write
    7. 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.
    8. 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 100 for Number of requests and 1 minute for Time interval.
  8. (Optional) Enable Logging toggle to keep 24 hours of logging for support purposes.

    Rate limiting and logging toggles

  9. Select Save to proceed.
  10. Under OAuth Authorization, select Authorize to log in with your service account. A pop-up appears with a Webex 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 Webex HTTP connector specifications.

Use Webex Meetings microapp

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

Create a Meeting: Schedule a meeting with the option to select duration, time zones, invitees, and co-hosts.

Notification or Page Use-case workflows
Create a Meeting page Provides a form to schedule a meeting with the following details according to user preference: Meeting Title, Start and End Time, Time Zone, Recurrence (once, daily, weekly, monthly), Password, Meeting Attendees, and Co-host for the meeting.

Integrate Webex