Salesforce API Setup

Log into your salesforce account as an administrator.

(depictions below based on SalesForce Lightning Experience)

Click the settings gear


 Click the arrow next to apps to expand then click on apps manager 

Click New Connected App

Fill in the required fields marked with a red stripe. Optionally add a description

  • Click on Enable OAuth settings to show the OAuth settings.
  • Add the url of your PBX. Note this MUST be https and you MUST include the full path including the parameters as shown.
  • Add the scopes shown below. Full is NOT full. The other scopes are needed.

Click Save

After clicking save,  the page will refresh and display the new connected app settings; copy your consumer key and secret – you need this for module setup.

Click to reveal the consumer secret, you need this for module setup.



In the Admin UI click on the Settings menu and choose CRM Settings.
Assuming you have no other CRM configured you will see the following screen

For CRM Type choose Salesforce.

For PBX URL enter in the URL for your PBX. Note this must be a https address.

Click the Submit button.

On the reload you will get the Salesforce settings screen.

From the API setup above you should have copied down your key and secret for the app you created.

On the API Key field add the Key and in the API Secret field add the secret.

Click Submit.

Next, click the Get Salesforce Token.

This will open a new browser (tab or window) and will direct you to a Salesforce login page. If a Salesforce login page does not appear, check your browser settings/plugins to ensure nothing is preventing the new page from loading. If necessary use another browser or use Incognito mode for this step.

Login to Salesforce and click Accept. Follow whatever instructions are presented in order to grant the PBX access to your Salesforce account.

You will then be brought back to your PBX and see the following

if your User Count is 0 and you have just configured the system , from the command line of the pbx, run the following:

fwconsole crm -u -f

cache force updated prior to cache expiration

Salesforce Integration to FreePBX: