Skip to main content

About Absorb LMS

Absorb LMS is a cloud learning management system for employee training, compliance, and certification programs. Connecting Absorb LMS to Serval lets workflows query LMS data — users, courses, enrollments, departments, and related records — through the Absorb Integration API without exposing API credentials to workflow authors. This integration is read-only: it exposes 36 GET endpoints from the Integration API v2 spec. Write operations (creating users, enrolling learners, updating courses) are not available through Serval.
The Absorb LMS integration is in beta. Behavior and endpoint coverage may change as we expand the integration.

What the Absorb LMS integration enables

CapabilityDescription
User dataList and retrieve LMS users, authenticated admin profile, user management settings, certificates, and competencies
CoursesRead online courses, instructor-led courses, curricula, course sessions, and session details
EnrollmentsList and retrieve course enrollments for users and courses, including the authenticated admin’s own enrollments
OrganizationRead departments, groups, categories, roles, and custom field definitions
Learning structureRead prerequisites, learning paths, and enrollment keys
Workflow automationCall any supported GET endpoint from Serval workflows via the Absorb LMS API request action
Anything defined in the Absorb Integration API v2 documentation that is exposed as a GET in our spec can be accessed through Serval.

Prerequisites

Before connecting Absorb LMS to Serval, you will need:
  1. Admin access to your Absorb LMS portal (required to view Portal Settings and retrieve the private API key).
  2. The Integration API add-on enabled on your Absorb portal. Absorb provisions a private API key tied to your portal when Integration API access is active. If you do not see a Rest API Private Key in Portal Settings, contact your Absorb account team.
  3. Admin username and password for an Absorb administrator whose role grants access to the data you plan to read. The admin’s permissions in the LMS determine which API endpoints return data.

Retrieve your Absorb LMS credentials

1

Confirm Integration API access

Sign in to your Absorb LMS portal. If the Integration API add-on is enabled, you can retrieve a private API key from Portal Settings. If the key field is missing, work with your Absorb account team to enable Integration API access before continuing.
2

Copy the Rest API Private Key

In the Absorb admin interface:
  1. Click the menu icon and select Admin.
  2. Click the account icon and select Portal Settings.
  3. Scroll to Rest API Private Key and copy the value.
Treat the private API key like a password. Do not paste it into source control or share it across teams. If it is compromised, contact your Absorb administrator to rotate it.
3

Identify your Integration API host

Absorb serves the Integration API from regional gateway hosts separate from your learner-facing portal URL. Use the host that matches your organization’s region:
RegionAPI host
United Statesrest.myabsorb.com
Canadarest.myabsorb.ca
Europerest.myabsorb.eu
Australiarest.myabsorb.com.au
United Kingdomrest.myabsorb.co.uk
Sandboxrest.sandbox.myabsorb.com
Paste only the hostname — no https:// prefix and no path.
4

Choose admin credentials

Select an Absorb admin username and password to use for API authentication. A System Admin can access the broadest set of endpoints. The admin’s LMS role determines what data the Integration API returns.

Connect Absorb LMS to Serval

1

Open the Absorb LMS integration in Serval

Navigate to AppsAvailableAbsorb LMSConnect.
2

Fill in the connection form

Paste the values you captured above:
FieldValue
API HostYour regional Integration API gateway (e.g. rest.myabsorb.com, rest.myabsorb.eu, rest.myabsorb.ca, rest.myabsorb.com.au, or rest.sandbox.myabsorb.com).
Private API KeyThe Rest API Private Key from Absorb Portal Settings. Sent as the x-api-key header on every request.
Admin UsernameAbsorb admin username used to obtain API tokens via /authenticate.
Admin PasswordPassword for the admin account. Stored encrypted; used only by the Serval proxy to mint short-lived bearer tokens.
Click Save.
3

Verify the connection

Open the connected Absorb LMS integration and run health checks:
  • <001> Test Connection — fetches the authenticated admin profile via /my-details.
  • <002> List Users, <003> List Online Courses, <004> List My Enrollments, <005> List Departments, <006> List Categories — confirm read access to common LMS resources.
A successful Test Connection result confirms Serval minted a bearer token with your credentials and that Absorb accepted the request.

How authentication works

Every time a Serval workflow calls the Absorb Integration API, the Serval proxy:
  1. Decrypts your stored private API key, admin username, and admin password. None of these values leave the proxy — workflow code only sees an opaque integration ID.
  2. Calls POST https://{apiHost}/authenticate with a JSON body containing your admin username and password, plus headers x-api-key, x-api-version: 2, and Content-Type: application/json.
  3. Receives a short-lived bearer token from Absorb and caches it until five minutes before expiry, then refreshes automatically.
  4. Attaches these headers to the outbound API request:
    • x-api-key: <private API key>
    • Authorization: Bearer <token>
    • x-api-version: 2
  5. Forwards the request to your configured API host and streams the response back to the workflow.
The proxy only allows requests to Absorb Integration API gateway hosts matching your configured region.

Using Absorb LMS in workflows

Once connected, call Absorb from workflows with the Absorb LMS API request action. Pass the path, method, and optional query — Serval resolves the API host from the connection and injects authentication automatically. List endpoints support offset-based pagination with _offset and _limit query parameters, plus optional _sort, _filter, and modifiedSince on many resources:
GET /users?_offset=0&_limit=100
GET /online-courses?_offset=0&_limit=50&modifiedSince=2024-01-01T00:00:00Z

Rotating credentials

  1. In Absorb, rotate the Rest API Private Key or update the admin password as needed through Portal Settings or your admin user management.
  2. In Serval, open the Absorb LMS integration’s configuration form.
  3. Paste the new values. Leaving a password field blank preserves the previously stored value, so you must paste a new password explicitly for it to take effect.
  4. Save and re-run Test Connection.

Troubleshooting

Health check fails with 401 Unauthorized. - Verify the private API key exactly matches the value in Absorb Portal Settings — no leading or trailing whitespace. - Confirm the admin username and password are correct and the account is active. - Confirm Integration API access is enabled on your portal.
Health check fails with a connection or DNS error. - The API Host is wrong. Use the regional Integration API gateway (e.g. rest.myabsorb.com), not your learner-facing portal URL (e.g. yourcompany.myabsorb.com). - Paste only the hostname, with no https:// prefix and no path.
Health check succeeds but list endpoints return empty or 403. - The admin account may lack permission for that resource. Try a System Admin account or adjust the admin’s LMS role in Absorb.

External resources

Need help? Contact support@serval.com for assistance with your Absorb LMS integration.