Português do Brasil

Articles in this section

Salesforce: connect to the LearnUpon API

Elizabeth
  • Updated

Summary

Connect the LearnUpon API to your Salesforce environment, to use Salesforce Builder, Salesforce Flow, and custom API calls with Salesforce.

Connecting the LearnUpon API is not required for the basic LearnUpon integration for Salesforce.

LearnUpon’s API and the Salesforce integration are available depending on your LearnUpon plan.

Access permissions

This process requires:

  • a Salesforce user account with admin permissions
  • a LearnUpon admin account with full portal permissions
  • access to LearnUpon API keys. See Use the LearnUpon API

Warning: A portal can only have one active set of API keys at a time. Generating a new set of keys invalidates any existing keys, and will break any current integrations. Generate new keys only if you're certain you need them.

1. Add a new API connection in Salesforce

In your Salesforce environment, navigate to LearnUpon API Setup. For this process, the username and password are your API keys generated in LearnUpon.

  1. Log into Salesforce and select App Launcher, aka the waffle icon waffle_icon.png.
  2. Use Search to find and open LearnUpon API Setup.
  3. From LearnUpon API Setup, select Add New API Connection.
  4. In the LearnUpon API Setup dialog that opens, enter:
    • Portal URL. This field requires the requires the subdomain only: for myportal.learnupon.com, enter myportal
    • Username
    • Password
  5. select Save to finish the setup.

2. Assign the LearnUpon API Setup Admin permission set to admins

In Salesforce, choose the admins who can access the LearnUpon API Setup object.

Warning: to protect your LearnUpon API keys, assign this permission set only to admins who add API connections to your Salesforce environment.

To assign the LearnUpon API Setup Admin permission set in Salesforce:

  1. Log into Salesforce and navigate to ​Setup, aka the gear icon gear_icon.png.
  2. Use Quick Find to search for and open Users.
  3. Select Permission Sets.
  4. Select LearnUpon API Admin Setup.
  5. From Permission Sets select ​Manage Assignments.
  6. Select Add Assignments.
  7. Assign the permission set to your admins as required, and select Next to continue.
  8. On the next page that opens, select Assign.
  9. Select Done to finish.

Salesforce displays the list of selected admins who can access the LearnUpon API Setup object.

3. Track API calls from Salesforce to LearnUpon

When a Salesforce Flow sends API calls to LearnUpon, Salesforce logs the outcome of the call in LearnUpon API Call Logs. 

The tab ​LearnUpon API Call Logs​ shows:

  • what API calls Salesforce made to LearnUpon
  • the status of those calls
  • any issues with outgoing API calls

You can also link a Flow to records created in this object. For example, you can track failed calls: create a workflow rule to send a notification email whenever the status code is not equal to HTTP 200 for a successful call.

To access the LearnUpon API Call Logs:

  1. From main navigation select App Launcher, aka the waffle icon.
  2. Use Search to find and open LearnUpon API Call Logs.
  3. Select LearnUpon API Call Logs to view and filter the results as required.

See:

Related articles