Skip to main content

Workramp

WorkRamp is a learning and development platform for building academies, certifications, trainings, and learning paths. Its Academies REST API lets you read learners, registrations, trainings, certifications, and path progress, and manage users and registrations programmatically. Nexla connects to the WorkRamp Academies API to ingest this learning data into your pipelines and to push user and enrollment changes back into your academy.

Workramp icon

Power end-to-end data operations for your Workramp API with Nexla. Our bi-directional Workramp connector is purpose-built for Workramp, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Workramp or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Workramp workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a WorkRamp credential, you need an API key for your WorkRamp academy. The Academies API is served from https://app.workramp.com/api/v1/academies/ and uses Bearer token authentication, with the API key sent in the Authorization header as Bearer <your-api-key>.

API keys can only be generated by WorkRamp Admin users. To obtain your API key:

  1. Sign in to WorkRamp with an Admin account.

  2. Navigate to Settings > Integrations > API.

  3. Generate an API key, then copy and store it securely. WorkRamp validates that the key belongs to an active Admin user on every request, so keep the generating account active.

  4. If a key is compromised, contact WorkRamp to have it invalidated and generate a replacement.

For more detail on WorkRamp API authentication and available endpoints, see the WorkRamp Academies API documentation.

Authenticate

Credentials required

Bearer token authentication using Workramp API key passed in Authorization header.

FieldRequiredSecretDescription
API Key ValueYesYesAn encoded string value used as a secret token to authenticate API requests
Base URLYesNoWorkramp API base URL for academy endpoints.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your WorkRamp API key in the API Key Value field. This value is sent as a Bearer token in the Authorization header for all API requests and must be kept confidential.

  4. Enter the Base URL for your academy endpoints. This defaults to https://app.workramp.com/api/v1/academies/ and generally does not need to be changed.

    WorkRamp validates that the API key belongs to an active Admin user on every request. If the generating account is deactivated or loses Admin access, API calls made with its key will fail.

    For detailed information about WorkRamp API authentication and available endpoints, see the WorkRamp Academies API documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Workramp connector tile, then select the credential that will be used to connect to WorkRamp, and click Next; or, create a new Workramp credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common WorkRamp endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Awarded Certifications

Returns a list of certifications that have been awarded to users in the academy.

  • This endpoint retrieves awarded certification records from the awarded_certifications endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about awarded certifications and available response fields, see the WorkRamp Academies API documentation.

[Rest API] List Certifications

Returns a list of all certifications available in the academy.

  • This endpoint retrieves certification records from the certifications endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about certifications and available response fields, see the WorkRamp Academies API documentation.

[Rest API] List Learning Paths Users

Returns a list of user enrollments and progress in learning paths.

  • This endpoint retrieves learning path enrollment records from the paths_users endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about learning path enrollments and available response fields, see the WorkRamp Academies API documentation.

[Rest API] List Registrations

Returns a list of user registrations for trainings and courses in the academy.

  • This endpoint retrieves registration records from the registrations endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about registrations and available response fields, see the WorkRamp Academies API documentation.

[Rest API] List Trainings

Returns a list of all training courses available in the academy.

  • This endpoint retrieves training course records from the trainings endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about trainings and available response fields, see the WorkRamp Academies API documentation.

[Rest API] List Users

Returns a list of all users in the academy.

  • This endpoint retrieves user records from the users endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about users and available response fields, see the WorkRamp Academies API documentation.

[Rest API] List Learning Paths

Returns a list of all learning paths offered in the academy.

  • This endpoint retrieves learning path records from the paths endpoint. Results are paginated, and Nexla automatically iterates through the pages to fetch the complete dataset.

For detailed information about learning paths and available response fields, see the WorkRamp Academies API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

WorkRamp data sources can also be manually configured to ingest data from any valid WorkRamp Academies API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Workramp data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Workramp destination, and select the Send to Destination option from the menu. Select the Workramp connector from the list of available destination connectors, then select the credential that will be used to connect to WorkRamp, and click Next; or, create a new Workramp credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common WorkRamp endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create User

Create a new user in the Workramp academy.

  • This endpoint sends each record from your Nexset as a JSON request body to the users endpoint to create a new academy user. Ensure each record contains the fields required by the WorkRamp API for user creation.

For detailed information about the user creation request body and required fields, see the WorkRamp Academies API documentation.

[Rest API] Update User

Update an existing user in the Workramp academy.

  • This endpoint sends each record from your Nexset as a JSON request body to update an existing academy user. It requires a User ID parameter that identifies the user to update, which is appended to the endpoint URL.

Provide the User ID for the user you want to update when configuring this endpoint. For detailed information about the user update request body and required fields, see the WorkRamp Academies API documentation.

[Rest API] Create Registration

Register a user for a training course in the Workramp academy.

  • This endpoint sends each record from your Nexset as a JSON request body to the registrations endpoint to register a user for a training. Ensure each record contains the fields required by the WorkRamp API to create a registration.

For detailed information about the registration request body and required fields, see the WorkRamp Academies API documentation.

Manual configuration

WorkRamp destinations can also be manually configured to send data to any valid WorkRamp Academies API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

WorkRamp APIs expect JSON format for write operations. For update operations, include the ID of the object to be updated at the end of the URL.

Save & activate

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 Workramp endpoint, open the destination resource menu, and select Activate.

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