Salesforce Authentication
Salesforce integration is managed through the Vonage API Dashboard. Once configured, it becomes available directly in AI Studio via the Salesforce node.
To get started, you first need to create a Salesforce External Client App. See How to create a Salesforce External Client App for full instructions.
Set up the integration in the API Dashboard
Once your external client app is created, complete the setup in the Vonage API Dashboard.
Log in to the Vonage API Dashboard and make sure you are in the correct client account.
Navigate to Build > Tools and Solutions > Integrations > Credential Storage.
Select Connect with Salesforce via OAuth.
Enter the following details:
Name
A label you select when using this integration in AI Studio. If you have multiple Salesforce environments, use a name that reflects the environment, for example, Salesforce Production or Salesforce QA.
Consumer Secret
The Consumer Secret from your Salesforce external client app.
Consumer Key
The Consumer Key from your Salesforce external client app.
Domain
Your Salesforce org's unique subdomain. Enter the domain only, without the https:// prefix. For example, yourcompany.my.salesforce.com.
DNS errors
If you get DNS errors when trying to authorise, check that you are using the correct domain. For example, some orgs require yourcompany.develop.my.salesforce.com instead of yourcompany.my.salesforce.com.
Click Connect with Salesforce OAuth. You are redirected to Salesforce to approve access.
Click Allow. On success, a confirmation page states that the OAuth connection has been completed.
Your integration now appears in the list of available credentials in AI Studio.
Use the Salesforce integration in AI Studio
Once the integration is set up in the API Dashboard, it is available in your virtual assistant flows via the Salesforce node.
In your virtual assistant, navigate to Integrations and add a Salesforce node.
The node automatically retrieves the integrations configured in the API Dashboard for the current account.
Select the integration you want to use from the dropdown.
Configure your query within the node and test the request.
The Salesforce node manages authentication internally. You do not need a separate authentication node or token parameter. You can switch between different Salesforce environments (for example, production and sandbox) by selecting the appropriate credential from the dropdown.
Integrate with a Salesforce sandbox environment
Sandbox environments
Currently, the recommended method for integrating with Salesforce sandbox environments is via Webhook.
Use the following configuration:
Method
POST https://your-tenant-domain.my.salesforce.com/services/oauth2/token
Headers
Content-Type
application/x-www-form-urlencoded
Query parameters
grant_type
password
client_id
Your Consumer Key
client_secret
Your Consumer Secret
username
Your API username
password
Your API user's password
Response mapping
access_token
$SF_ACCESS_TOKEN (or the parameter where you want to store the token)
Special characters in passwords
If your password contains special characters such as #, use URL encoding.
For example, #42LBMDEH becomes %1242LBMDEH. You can use Postman to encode your password before use.
Troubleshooting
For error tracking, see the following Salesforce documentation:
Last updated
Was this helpful?