Webex and Salesforce Setup

It is assumed that there is an existing production Webex environment with defined users who have rights to create meetings and webinars.

For setup, access to the Webex Developers portal as well as a Webex org’s Webex Control Hub is needed. If not already done, sign up to the developer portal at https://developer.webex.com/

Creating an Integration App

To integrate between EventSpark and Webex, a Webex Integration App must be defined.

This assumes that one has not yet been defined.

Integration must be created by a Webex user with Admin rights.

• Log into the Webex for Developers portal

• Click on your Name

• Click on My Webex Apps

• Click on Create a New App

• Click Create an Integration

  • Enter the following:

    • Integration Name e.g., EventSpark Webex Integration

    • Icon

    • App Hub Description e.g., Integrating EventSpark with Webex

    • Redirect URI(s): This needs to be filled in later once a Salesforce Auth. Provider has been defined

    • Selected Scopes:

      • meeting:admin_participants_read

      • meeting:admin_schedule_read

      • meeting:admin_schedule_write

      • meeting:admin_recordings_read

• When the Integration is created, you should have a Client Id and Client Secret.

• These are used when setting up a Salesforce Auth. Provider for Webex.

• The scopes need to be echoed in the Salesforce Auth. Provider and Named Credential scopes.

Dev environment

If you want a standalone testing environment, you can create a Webex developer sandbox.

Creating a Webex Sandbox

• To create a sandbox, follow these instructions https://developer.webex.com/docs/developer-sandbox-guide#

• You will receive an email with the following details

  • Sandbox Name

  • Sandbox Username

  • Sandbox Password

  • Webex Site URL

• Meetings and Webinars are created against this site URL

Administering Webex Sandbox

Administration is done in the Webex Control Hub.

• To access the Webex Control Hub, navigate to https://admin.webex.com and login with your sandbox username and password.

Add Users

Meetings and webinars can be hosted by different users. These users are defined, verified, and allocated specific licenses to allow hosting of meetings/webinars.

• To add a user within the Webex Control Hub, navigate to MANAGEMENT > Users

• Select Manage Users

• Select Manually Add User

  • Enter basic information

  • Click the + button

  • Click the Next button

Assign Licenses

• Select Meeting

• Check

  • Webex Assistant for Meetings

  • Advanced space

  • Real-time transactions

  • Webex Meeting Suite

• Click Next

• Click Add Users

  • The user should receive a verification email

To view site details

Meetings and webinars are linked to a Webex site.

• Navigate to SERVICES > Meeting

• A row with the Site Name is shown

Site Administration

Meeting/Webinar Preferences can be set on the site. For example, locale details such as Time zone can be changed.

• Log into the site using the site name as the URL

• Sign in using the sandbox username and password

Change Call-in numbers

• Navigate to Preferences

• Select the Audio and Video Tab

• Change default call-in numbers

Salesforce Setup

For Salesforce to connect to Webex, an Auth. Provider and Named Credential must be defined. In addition, EventSpark Virtual Platform Connection and virtual Venue records need to be created.

Auth. Provider

• In Salesforce Setup create a new Auth. Provider

• Fill in the following:

  • Provider Type: Open ID Connect

  • Name: Your choice

  • Consumer Key: Webex Integration Client ID

  • Consumer Secret: Webex Integration Client Secret

  • Authorize Endpoint URL: https://webexapis.com/v1/authorize

  • Token Endpoint URL: https://webexapis.com/v1/access_token

  • Default Scopes: meeting:admin_schedule_read meeting:admin_schedule_write meeting:admin_recordings_read meeting:admin_participants_read

  • Send access token in header: Checked

• Save

• Once saved, under Salesforce Configuration, the Callback URL will be available.

• Update the Webex Integration App Redirect URI(s) with this value

  • e.g. https://drive-computing-4720-dev-ed.my.salesforce.com/services/authcallback/Webex_AuthProvider

Named Credential

Since Winter ’23, Salesforce has a new Named Credential schema. The below instructions are for the previous schema whose type is Legacy.

Create a Named Credential that references the Auth. Provider that was created.

• In Salesforce Setup, create a New Legacy Named Credential

• Fill in the following:

  • Label: Your choice

  • URL: https://webexapis.com/v1

  • Identity Type: Named Principal

  • Authentication Protocol: OAuth 2.0

  • Authentication Provider: References a Webex Auth. Provider

  • Scope: meeting:admin_schedule_read meeting:admin_schedule_write meeting:admin_recordings_read meeting:admin_participants_read

  • Generate Authorization Header: Checked

  • Allow Merge Fields in HTTP Header: Checked

  • Allow Merge Fields in HTTP Body: Checked

• Save

• On save the connection is authenticated

  • User your Webex org credentials. For example, if connecting to a Webex sandbox use your sandbox username and password

• If this is successful, the Authentication Status = Authenticated

• If it is not successful, the configuration of both Salesforce and Webex needs to be reviewed and if necessary corrected.

EventSpark Virtual Platform Record

Create an EventSpark Virtual Platform record that references the Named Credential.

• Navigate to App EventSpark Setup

• Select the Virtual Platform Connection Tab

• Select New

• Fill in the following fields:

  • Virtual Platform Connection Name: Your choice

  • Service Provider: Webex

  • Named Credential: The applicable Webex Named Credential

• Save