Skip to main content

LearnUpon Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a LearnUpon location.
learnupon_api.png

LearnUpon

  1. Click the + icon on the Nexset that will be sent to the LearnUpon destination, and select the Send to Destination option from the menu.

  2. Select the LearnUpon connector from the list of available destination connectors. Then, select the credential that will be used to connect to the LearnUpon organization, and click Next; or, create a new LearnUpon credential for use in this flow.

  3. In Nexla, LearnUpon destinations can be created using pre-built endpoint templates, which expedite destination setup for common LearnUpon write operations. Each template is designed specifically for the corresponding LearnUpon endpoint, making destination setup easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    LearnUpon destinations can also be configured manually, allowing you to send data to LearnUpon endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common LearnUpon endpoints. Each template is designed specifically for the corresponding LearnUpon endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.

    Create User

    Create a new user account in your LearnUpon portal by sending a POST request with the required user details.

    • Issues a POST request to https://{subdomain}.learnupon.com/api/v1/users. The request body should include user fields such as first name, last name, email address, and password.
    • No additional parameters are required to configure this template beyond ensuring the Nexset data contains the required user fields.

    Email addresses must be unique within the LearnUpon portal. If a user with the specified email already exists, the API will return an error. Consider using the Update User endpoint for existing users.

    Update User

    Update an existing user record in your LearnUpon portal by specifying the user ID and sending updated field values in the request body.

    • Issues a PUT request to https://{subdomain}.learnupon.com/api/v1/users/{user_id}. The user ID is passed as a path parameter.
    • Configure the following parameters: User ID — the numeric ID of the LearnUpon user to update (required).

    The User ID must correspond to an existing user in the portal. Use the Get Users source endpoint to retrieve user IDs, or reference a lookup containing user IDs from a previous data flow step.

    Create Enrollment

    Enroll a user in a course in your LearnUpon portal by sending a POST request with the required user and course identifiers.

    • Issues a POST request to https://{subdomain}.learnupon.com/api/v1/enrollments. The request body should include the user ID and course ID to create the enrollment.
    • No additional parameters are required to configure this template beyond ensuring the Nexset data contains valid user IDs and course IDs.

    Both the user ID and course ID must be valid existing records in the portal. Consider using the Get Users and Get Courses source endpoints to retrieve the required IDs before running this destination.

    Create Group Membership

    Add a user to a group in your LearnUpon portal by sending a POST request with the user ID and group ID.

    • Issues a POST request to add a group membership record in LearnUpon. The request body should include the user ID and the ID of the group to which the user should be added.
    • No additional parameters are required to configure this template beyond ensuring the Nexset data contains valid user IDs and group IDs.

    Use the Get Groups source endpoint to retrieve group IDs before running this destination. Adding a user to a group may automatically trigger course assignments if the group has associated learning assignments configured.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can send a test payload to the LearnUpon API to verify that the destination is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. A test payload will be sent & the result will be displayed in the Endpoint Test Result panel on the right.

  • If the test result is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the result to ensure that the correct response is returned.

Configure Manually​

LearnUpon destinations can also be configured manually, allowing you to send data to LearnUpon endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.

First, select the API method that will be used for calls to the LearnUpon API from the Method pulldown menu. Common methods for write operations include:

  • POST: For creating new records (users, enrollments, group memberships)
  • PUT: For replacing existing records
  • PATCH: For partial updates to existing records
  • DELETE: For removing records

Data Format​

  1. Select the format in which the Nexset data will be sent to the LearnUpon API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The LearnUpon API accepts JSON-formatted request bodies for write operations.

API Endpoint URL​

  1. Enter the URL of the LearnUpon API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    The LearnUpon REST API base URL follows the format https://{subdomain}.learnupon.com/api/v1, where `{subdomain}` is your portal-specific subdomain. Common write endpoint paths include:

    • https://{subdomain}.learnupon.com/api/v1/users — create new user accounts (POST)
    • https://{subdomain}.learnupon.com/api/v1/enrollments — enroll users in courses (POST)
    • https://{subdomain}.learnupon.com/api/v1/groups/{group_id}/memberships — add users to groups (POST)
    • https://{subdomain}.learnupon.com/api/v1/users/{user_id} — update a user record (PUT/PATCH)

    For update or upsert operations, include the ID of the object to be updated at the end of the URL.

For a complete list of available LearnUpon API write endpoints and required request body schemas, refer to the official LearnUpon API documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include Authorization headers — Nexla automatically applies the HTTP Basic Authentication credentials configured in your LearnUpon credential.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this LearnUpon destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings — click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the LearnUpon API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, the newly created user ID returned after a successful user creation request.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the LearnUpon API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the LearnUpon API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the LearnUpon API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured LearnUpon endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to LearnUpon until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.