How to create a Salesforce external client app

To connect to Salesforce, you'll need to create a Salesforce external client app and configure it to work with Vonage AI Studio. This can be done in your Salesforce production or sandbox org.

Create the external client app

  1. Click the gear icon in the upper-right corner of your Salesforce screen and select Setup.

  2. In the left navigation bar, under Platform Tools, expand Apps and click App Manager.

  3. Click New External Client App in the upper-right corner.

  1. Under Basic Information, fill in the following fields:

Fied
Value

Name

Enter a recognisable name, such as Vonage AI Integration.

API Name

Auto-populates based on the name you enter. Leave it as is.

Contact Email

Enter the email address of the person or team responsible for setting this up. This does not need to be the email of the Salesforce user who will use the integration.

Distribution State

Select Local.

This means the app is used only within this specific Salesforce org. The Packaged option is for apps published to the Salesforce AppExchange, which is not applicable here.

  1. Under API (Enable OAuth Settings), check the Enable OAuth box.

  2. In the Callback URL field, enter: https://api-eu.vonage.com/oauth/redirect.

  1. Under OAuth Scopes, add the following three scopes to Selected OAuth Scopes:

    • Manage user data via APIs (api).

    • Full access (full).

    • Perform requests at any time (refresh_token, offline_access).

  2. Under Flow Enablement, leave all options unchecked.

  3. Under Security, configure the checkboxes as follows:

Setting
Value

Require Secret for Web Server Flow

Checked

Require Secret for Refresh Token Flow

Checked

Require Proof Key for Code Exchange (PKCE)

⬜ Unchecked. This must be disabled for the integration to work correctly.

  1. Click Create. A confirmation message appears to confirm that the external client app was created successfully.

Configure OAuth policies

After creating the app, you need to update its OAuth policies.

  1. On the External Client App page, click Edit.

  2. Navigate to the Policies section and click Edit.

  3. Set the following policies:

Section
Field
Value

Plugin Policies

Permitted Users

All users can self-authorize.

App Authorization

Refresh Token Policy

Refresh token is valid until revoked

App Authorization

IP Relaxation

Relax IP restrictions

Retrieve your Consumer Key and Consumer Secret

Once your external client app is created and policies are saved, retrieve the credentials you'll need to complete the setup in the Vonage API Dashboard.

  1. From the External Client App page, click Settings.

  2. Under OAuth Settings, click Consumer Key and Secret.

  3. Salesforce will send a verification code to your registered email address. Enter the code when prompted.

  4. Copy the Consumer Key and Consumer Secret. You'll need both when setting up the Salesforce integration in the Vonage API Dashboard.

Retrieve credentials from an existing app

If you've already created an external client app and need to retrieve the credentials again:

  1. Go to Setup and navigate to App Manager.

  2. Find your external client app in the list and click Settings from its action dropdown.

  3. Under OAuth Settings, click Consumer Key and Secret.

  4. Complete the verification step if prompted. Your Consumer Key and Consumer Secret will then be displayed.

For further instructions on configuring external client apps, see:

Last updated

Was this helpful?