Skip to main content

LMS Integration - API or Flat File

Learn how Arist writes course records and completions back to your LMS, by API or flat file, which fields the catalog and completion feeds carry, and how courses and learners are matched by ID.

Platform access level: Org Admins


Arist sends the learning it generates back to the LMS you already run, so each learner's Arist training appears on their record in your system of record. If your LMS can exchange data through an API or a scheduled file, Arist can integrate with it. This guide explains what flows back, how the two systems stay matched, and how the connection is made, and it is written for the IT and LMS stakeholders who set it up.


1. Overview of the LMS connection

The learning Arist generates flows back into your LMS in two pieces: a course record, so completions have something to attach to, and the completion records themselves. This flow runs in one direction, from Arist to your LMS.

Note: There is no automated sync from your LMS back into Arist. Anything that originates in your LMS, such as a course built there, must be recreated in Arist by hand with a matching identifier.

Like the HRIS feed, the writeback runs one of two ways: through an API, or as a CSV flat file placed on a secure SFTP location.


2. Course shells Arist creates

When you build a course in Arist, Arist automatically creates a shell of that course in your LMS. The shell's only job is to give completions something to tie back to, so an empty shell in the catalog is expected until completions arrive.

Important: The External ID on the Arist course must match the Content ID on the LMS shell, following any ID format your LMS requires. This match is what lets a completion find its course.


3. Completion records Arist sends

As learners finish courses in Arist, each completion posts onto the learner's record in your LMS. Arist reports status as Completed, In progress, or Not started, so a learner's progress is reflected and not only their finished courses.


4. Matching courses and learners by ID

The whole writeback depends on two ID matches. When both line up, Arist posts the completion onto the right person's record automatically.

Pair

Arist side

Your side

What it links

The course

Course External ID

LMS Content ID

Ties a completion to the correct course

The learner

User ID

Source system User ID

Ties a completion to the correct person

Important: If either ID does not match, the completion has nowhere to land. Keep both consistent from day one, and follow any ID format your LMS requires. The learner User ID is the same Employee ID used by your HRIS feed, so the two files must use one identifier.


5. Catalog fields exchanged with your LMS

Two feeds move between Arist and your LMS. The course catalog comes first, because it defines what a completion can attach to.

The catalog feed carries the fields below.

Course field

Necessity

Notes

Content or Course ID

Required

Primary key, matched to the Arist course External ID

Course title

Required

Reference

Author, duration, description, category, language, modality, status, launch URL, version, last updated

Optional

Catalog metadata used for grouping and reporting


6. Fields in the completion feed

The completion feed reports each learner's result against a course in that catalog.

Completion field

Necessity

Notes

User or Student ID

Required

Maps to the HRIS Employee ID; both files must use the same identifier

Course code

Required

Maps to the Content or Course ID in the catalog

Date completed

Required

ISO 8601 preferred

Completion status

Required

Completed, In progress, or Not started

Course title

Optional

Reference only, since matching is on the course code

Score

Optional

Percent or points, confirm the scale


7. Connecting by API or flat file

Both methods carry the same records. Choose the one that fits how your LMS accepts data.

  • API: Arist's External API uses a single per-organization key, sent in an Authorization header, to write course records and completions, or Arist calls your LMS's own API where one is available.

  • CSV flat file over SFTP: Arist places a file on a secure SFTP location on a schedule, and your team imports it. Credentials are exchanged securely and the transfer is encrypted.

A typical cadence is a full course catalog weekly and completions daily, sent incrementally so only new and changed records move.


8. What your team provides

Arist sends you an integration data request workbook to capture the specifics. You fill the source field for each Arist field with the exact field name from your system, confirm which course types or codes should be sent back, and return it.

  • For an API connection: Provide the endpoint URLs, credentials, and the ID format your LMS expects for content and users.

  • For a flat file: Provide the SFTP details and a sample file, so Arist can confirm the format and the ID matches before the first full run.


Related articles

  • HRIS Integration - API or Flat File

  • HRIS and LMS Integration - Technical Guide

Note: Need help at any point? Reach out to your Arist Customer Success contact, or email [email protected].

Did this answer your question?