Connector: Enrollments

Introduction

The Docebo Connect connector is responsible for communicating with the Docebo platform using the provided actions which, in the background, communicate with the platform’s APIs.

This article describes enrollment actions available for use in the Docebo connector.

Enrollment actions supported by the connector

These actions manage user enrollment in courses and learning plans. Unless otherwise stated, all input fields are optional.

Get enrollments

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Get enrollments

Retrieves a list of course and learning plan enrollments based on specified filters, such as user ID, course ID, status, and dates. Includes options for pagination and returning session details.

Input Field Name	Data Type	Description
ID User	Array of Objects	An array of user IDs used to retrieve the entries
ID Course	Array of Objects	An array of course IDs used to retrieve the entries
Code course	Array of Objects	An array of course codes used to retrieve the entries
ID learning plan	Array of Objects	An array of learning plan IDs used to retrieve the entries
Code learning plan	Array of Objects	An array of learning plan codes used to retrieve the entries
Course status	String	A list of comma separated course statuses. Possible values are: `not_started` `in_progress` `completed`
Course type	String	A list of comma separated course types. Possible values are: `elearning` `classroom` `learning_plan`
Deadline	Date/Time	If set, returns only enrollments that expire between the current time and the specified time
Updated from	Date/Time	If set, returns only enrollments updated after a specified time
Updated to	Date/Time	If set, returns only enrollments updated before a specified time
Rating	Integer	If set, returns only enrollments that have a minimum the selected rating. Possible values are: `1` `2` `3` `4` `5` `6`
Channel	Integer	Filter enrollments that are found inside the given channel by channel ID
Search	String	Filtering results by wildcard match on the passed string
Get session details	Boolean	Return a list of sessions for each enrollment. Possible values are: `true` or `Yes` `false` or `No`
Level	String	Filter results by the selected enrollment level. Possible values are: `student` `instructor` `tutor` `coach`
Cursor	String	Data set navigational cursor previously obtained by passing `get_cursor` set to `Yes`
Get cursor	Integer	Generates and returns cursor and prebuilt navigational `_links`. Possible values are: `1` or `Yes` `0` or `No`
Sort by	String	Choose the sorting attribute and direction. Possible sorting values are: `alpha_asc` - By course name ascending `alpha_desc` - By course name descending `enrolled_date_asc` - By enrollment date ascending (oldest to newest) `enrolled_date_desc` - By enrollment date descending (newest to oldest) `deadline_asc` - By deadline ascending (oldest to newest) `deadline_desc` - By deadline descending (newest to oldest) `session_start_asc` - By session start date ascending (oldest to newest). This sorting value is applicable only if the input field Show upcoming sessions value is set to `true` or `Yes`. `session_start_desc` - By session start date descending (newest to oldest). This sorting value is applicable only if the input field Show upcoming sessions value is set to `true` or `Yes`. `score_asc` - By score ascending `score_desc` - By score descending `code_asc` - By code ascending `code_desc` - By code descending
Exclude courses in lp	Boolean	Exclude courses that belong to a learning plan. Possible values are: `true` or `Yes` `false` or `No`
Show upcoming sessions	Boolean	Include only courses with upcoming sessions. Possible values are: `true` or `Yes` `false` or `No`
Page size	Integer	Specify the maximum number of results per page
Page	Integer	Specify the page number to return. The default value is `1`.
Skills	Array of Objects	An array of skills IDs
Search text	String	Search text in the course name, course description or course code or in the learning plan name, learning plan description or learning plan code.
Duration from seconds	Integer	Filter by course duration. Retrieve the courses with duration equal to or greater than the provided value. The duration value is specified in seconds.
Duration to seconds	Integer	Filter by course duration. Retrieve the courses with duration equal to or less than the provided value. The duration value is specified in seconds.
Content partners	Array of Objects	An array of content partner IDs
Is paid	Boolean	Set to `true` or `Yes` to filter by paid courses. Set to `false` or `No` to filter by free courses.
With visibility	String	Filter the results by visibility. Possible values are: `visible` `hidden` `both`
Language	String	A list of comma-separated language codes. For a list of supported languages and their corresponding codes, please view the column marked lang_browsercode in the article List of supported languages (opens in a new tab).
Course Additional fields	Object	Search a specified course additional field Please note: You can choose only one course additional field here.

Output Field Name	Data Type	Description
Enrollments	Object	The main wrapper object for the API response
Data	Object	The main collection of items and pagination metadata
Items	Array of Objects	A list of matching enrollment records
ID	Integer	The enrollment ID (usually a course or learning plan ID)
User ID	Integer	The ID of the enrolled user
Date last updated	String	The last update date for this enrollment
Subscribed by	Integer	The ID of the user who performed the subscription
Username	String	The username of the enrolled user
Name	String	The name of the course or learning plan
Slug	String	The URL slug name
Complete percent	Integer	The percentage of the content completed
Description	String	The description of the item
Type	String	The type of enrollment (for example, `elearning`, `classroom`).
Status	String	The enrollment status (for example, `not_started`, `completed`).
Location name	String	The location name (for classroom courses)
Webinar tool	String	The webinar tool used
Session begin date	String	The session begin date
Session time begin	String	The session start time
Session timezone	String	The session timezone
Lang code	String	The language code
Code	String	The course or learning plan code
Enroll begin date	String	The date enrollment is valid from
Enroll date of enrollment	String	The date the enrollment occurred
Enroll end date	String	The date enrollment is valid until
Course complete date	String	The course completion date
Total time	Integer	The total time spent
Score	Integer	The score achieved
Image URL	String	The URL of the course image
URL	String	The URL to access the course
Rating option	String	The rating option status
Rating	String	The rating given
Is new	Boolean	Returns `true` if the enrollment is considered new, otherwise `false`
Can enter	String	The status indicating if the user can enter
Can enter reason	String	The reason a user cannot enter
Duration	Integer	The course duration
Level	String	The user's level in the enrollment (for example, `student`)
Course count	Integer	The number of courses (for learning plans)
Soft deadline	String	The soft deadline details
Course end date	String	The date the course officially ends
Hidden	Boolean	Returns `true` if the course is hidden, otherwise `false`
Subscription	Object	Subscription details
Subscribed	Boolean	Returns `true` if the user is subscribed, otherwise `false`
Is active	Boolean	Returns `true` if the subscription is active, otherwise `false`
Enrolled sessions	Array of Objects	The details of enrolled sessions
ID	String	The session ID
Name	String	The session name
Description	String	The session description
Other Info	String	Other info about the session
Date begin	String	The start date of the session
Date end	String	The end date of the session
Min enrollments	Integer	The minimum number of enrollments
Max enrollments	Integer	The maximum number of enrollments
Score base	Integer	The base score of the session
Tool	String	The tool used by the session
Status	String	The status of the session enrollment
Dates	Array of Objects	The specific event dates and times within the session.
Date	String	The event date within the session
Name	String	The event name within the session
Time begin	String	The start time of the event
Time end	String	The end time of the event
Timezone	String	The timezone of the event
ID Classroom	Integer	The ID of the classroom the event is linked to
ID Location	Integer	The ID of the location the event is linked to
Attendance status	String	The status of the attendance of the user enrolled in the event
Outdated	Object	Outdated details (for example, compliance)
Total users	Integer	The total number of enrolled users
Already marked	Boolean	Returns `true` if the user is already marked, otherwise `false`
Count	Integer	The number of results in the current page
Has more data	Boolean	Returns `true` if there are more results available, otherwise `false`
Cursor	String	A cursor string for fetching the next page
Current page	Integer	The current page number
Current page size	Integer	The number of items returned in the current page
Total page count	Integer	The total number of pages available
Total count	Integer	The total number of enrollment records found
Sort	Object	Details about the sorting applied to the results
Links	Object	Navigation links (`_self`, `_next`, `_first`, `_last` and `_goto`) if the cursor is requested

This action calls an internal API.

This action does not generate a webhook event.

Enroll user into a course

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Enroll user into a course

Enrolls a specified user into a course using the provided course ID and user ID. Allows setting the enrollment level and optional validity dates

Input field name	Data type	Description
User ID	Integer	The user ID to enroll This field is required
Course ID	Integer	The ID of the course in which the user will be enrolled This field is required
Level	Integer	The user level. Possible values allowed are: `3` for student `4` for tutor `6` for instructor
Date begin validity	Date	The start date of the enrollment
Date end validity	Date	The expiration date of the enrollment
Enrollment fields	Object	Custom fields related to the enrollment (dynamic fields are shown here)

Output field Name	Data type	Description
Enrolled	Array of Objects	List of successfully enrolled users or courses.
User ID	Integer	The ID of the enrolled user
Course ID	Integer	The ID of the enrolled course
Waiting	Boolean	Returns `true` if the user is on a waiting list, otherwise `false`

This action is equivalent to calling POST/learn/v1/enrollments/{course_id}/{user_id}.

This action will generate the webhook event User enrolled in a course (course.enrollment.created).

Enroll user into a session

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Enroll user into a session

Enrolls a single user into a specific session within a course. Requires user ID, course ID, session ID, and enrollment level.

Input Field Name	Data Type	Description
User ID	Integer	The user ID to enroll This field is required
Course ID	Integer	The ID of the course in which the user will be enrolled This field is required
Level	Integer	The user level. Possible values allowed are: `3` for student `4` for tutor This field is required
Session ID	Integer	The session ID in which the user will be enrolled This field is required

Output Field Name	Data Type	Description
Enrolled	Array of Objects	List of successfully enrolled users or sessions.
User ID	Integer	The ID of the enrolled user.
Course ID	Integer	The ID of the parent course.
Waiting	Integer	Indicates if the user is in a waiting status. Possible returned values are: `0` for enrolled `1` for waiting

This action is equivalent to calling POST/learn/v1/enrollments.

This action will generate the webhook event User enrolled in ILT session (ilt.session.enrollment.created).

Unenroll user from course

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Unenroll user from course

Removes a specific user's enrollment from a given course. Requires the IDs of both the user and the course.

Input Field Name

Data Type

Explanation

User ID

Integer

The ID of the user to unenroll

This field is required

Course ID

Integer

The ID of the course from which the user will be unenrolled

This field is required

Output Field Name	Data Type	Explanation
Deleted Enrollment	Integer	The ID of the deleted enrollment record

This action is equivalent to calling DELETE/learn/v1/enrollment/{course_id}/{user_id}.

This action will generate the webhook event User unenrolled from course (course.enrollment.deleted).

Unenroll user from session

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Unenrolled user from session

Removes a specific user's enrollment from a given session within a course. Requires user ID, course ID and session ID.

Input Field Name	Data Type	Description
User ID	Integer	The ID of the user to unenroll This field is required
Course ID	Integer	The ID of the course containing the session from which the user will be unenrolled This field is required
Session ID	Integer	The ID of the session from which the user will be unenrolled This field is required

Output Field Name	Data Type	Description
Success	Boolean	Returns `true` if the unenrollment was successful

This action calls an internal API.

This action does not generate a webhook event.

Unenroll user from learning plan

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Unenrolled user from learning plan

Removes a user's enrollment from a learning plan. Includes options to cascade the unenrollment to all courses within the learning plan and reset tracked data.

Input Field Name	Data Type	Description
User ID	Integer	The user ID to unenroll This field is required
Learning Plan ID	Integer	The ID of the learning plan from which the user will be unenrolled This field is required
Reset tracks	Boolean	If set to `true` or `Yes` , resets all of the learner's tracked data. This option is valid only if Unenroll the user from learning plan courses is set to `true` or `Yes`.
Unenroll the user from learning plan courses	Boolean	If set to `true` or `Yes`, the user will be unenrolled from all the courses of the learning plan.

Output Field Name	Data Type	Description
Unenrolled	Array of Integers	An array of user IDs that were successfully unenrolled.

This action is equivalent to calling DELETE/learn/v1/enrollments.

This action will generate the webhook event Learning plan enrollment deleted (learningplan.enrollment.deleted). If the user is also unenrolled from a course or courses, each course unenrollment will trigger the User unenrolled from course (course.enrollment.deleted) webhook event also.

Get Course Enrollments

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Get Course Enrollments

Retrieves a list of enrollment records specifically for courses. Allows for filtering by user, course, type and status. It also provides sorting options.

Input Field Name	Data Type	Description
User IDs	Array of Integers	The user IDs to filter the results by
Course IDs	Array of Integers	The course IDs to filter the results by
Course Types	String	The course types to filter the results by. Possible values are: `elearning` `classroom` (ILT)
Enrollment Levels	String	The enrollment levels to filter the results by. Possible values are: `student` `instructor` `tutor`
Enrollment Status	String	Enrollment status to filter the results. Possible values are: `enrolled` - The learner is enrolled `in_progress` - The learner has started but not finished the course `completed` - The learner has completed the course `subscription_to_confirm` - The learner has been invited to enroll but has not yet done so `waiting` - The learner is waiting to enroll `suspended` - The enrollment is suspended `overbooking` - The enrollment is overbooked
Page	Integer	The page to return. The default value is `1`.
Page size	Integer	The maximum number of results per page
Sort by	String	It sorts the result by the selected attribute. Possible values are: `enrollment_created_at` - The date the enrollment was created `course_begin_date` - The date the course begins `course_end_date` - The date the course ends `enrollment_validity_begin_date` - The date after which the enrollment period is valid `enrollment_validity_end_date` - The date after which the enrollment period is closed `enrollment_completion_date` - The completion date of the enrollment
Sorting direction	String	The sorting direction. Possible values: `asc` - Ascending `desc` - Descending

Output Field Name	Data Type	Description
Items(List of Enrollment Records)	Array of Objects	The repeatable list of enrollment records for courses
User ID	Integer	The ID of the enrolled user
Username	String	The user's username
Course ID	Integer	The ID of the enrolled course
Course uid	String	The unique identifier of the course
Course code	String	The code of the course
Course name	String	The name of the course
Course type	String	The type of course (for example, `elearning` or `classroom`)
Course begin date	String	The official begin date for the course content
Course end date	String	The official end date for the course content
Enrollment level	String	The user's level in the enrollment (for example, `student` or `instructor`)
Enrollment status	String	The current status of the enrollment (for example, `enrolled` or `completed`)
Enrollment created by	Integer	The ID of the user who performed the enrollment
Enrollment created at	String	The date the enrollment was created
Enrollment validity begin date	String	The date the enrollment validity begins
Enrollment validity end date	String	The date the enrollment validity ends
Enrollment date last updated	String	The last date the enrollment status was updated
Enrollment completion date	String	The date the enrollment status became completed
Enrollment score	Integer	The score achieved in the course
Enrollment time spent	Integer	The time spent in the course (in seconds)
Count	Integer	The number of results in the current page
Has more data	Boolean	Returns `true` if there are more pages of results, otherwise returns `false`
Cursor	String	The cursor string for fetching the next page
Current page	Integer	The current page number
Current page size	Integer	The number of results per page returned
Total page count	Integer	The total number of pages available
Total count	Integer	The total number of all matching records
Sort (Sort Information)	Array of Objects	The details about the sorting applied to the results
Sort by	String	The attribute the results are sorted by. For example, `enrollment_created_at` or `course_begin_date`.
Sorting direction	String	The sorting direction. Possible values are: `asc` - Ascending `desc` - Descending

This action is equivalent to calling GET/course/v1/courses/enrollments.

This action does not generate a webhook event.

Get Learning Plan Enrollments

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Get Learning Plan Enrollments

Retrieves a list of enrollment records specifically for learning plans. Allows for filtering by user, learning plan ID and status. It also provides sorting options.

Input Field Name	Data Type	Description
User IDs	Array of Integers	An array of user IDs to filter the results by
Learning Plan IDs	Array of Integers	An array of learning plan IDs to filter the results by
Enrollment Status	String	The enrollment status to filter the results by. Possible values are: `not_started` - Not started `in_progress` - In progress `completed` - Completed `waiting` - Waiting
Page	Integer	The page to return. The default value is `1`
Page size	Integer	The maximum number of results per page
Sort by	String	Set the attribute to sort the results by. Possible values are: `enrollment_created_at` - The date the enrollment is created `enrollment_validity_begin_date` - The date the enrollment validity begins `enrollment_validity_end_date` The date the enrollment validity ends `enrollment_date_last_updated` - The last date the enrollment is updated `enrollment_completion_date` - The date the enrollment is completed
Sorting direction	String	The sorting direction. Possible values are: `asc` - Ascending `desc` - Descending

Output Field Name	Data Type	Description
Items (List of Enrollment Records)	Array of Objects	The repeatable list of enrollment records for learning plans
User ID	Integer	The ID of the enrolled user
Username	String	The user's username
Learning plan ID	Integer	The ID of the enrolled learning plan
Learning plan name	String	The name of the learning plan
Learning plan code	String	The code of the learning plan
Enrollment status	String	The current status of the enrollment (for example, `in_progress` or `completed`)
Enrollment created by	Integer	The ID of the user who performed the enrollment
Enrollment created at	String	The date the enrollment was created
Enrollment validity begin date	String	The date the enrollment validity begins
Enrollment validity end date	String	The date the enrollment validity ends
Enrollment date last updated	String	The last date the enrollment status was updated
Enrollment completion date	String	The date the enrollment status became completed
Enrollment completion percentage	Integer	The completion percentage achieved in the learning plan
Enrollment time spent	Integer	The time spent in the learning plan (in seconds)
Count	Integer	The number of results in the current page
Has more data	Boolean	Returns `true` if there are more pages of results, otherwise returns `false`
Cursor	String	The cursor string for fetching the next page
Current page	Integer	The current page number
Current page size	Integer	The number of results per page returned
Total page count	Integer	The total number of pages available
Total count	Integer	The total number of all matching records
Sort (Sort Information)	Array of Objects	Details about the sorting applied to the results
Sort by	String	The attribute used for sorting
Sorting direction	String	The sorting direction

This action is equivalent to calling GET/learningplan/v1/learningplans/enrollments.

This action does not generate a webhook event.

Get Learning Plan Course Enrollments

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Get Learning Plan Course Enrollments

Retrieves enrollment details for courses within a specified learning plan. Allows for filtering by user, course, type and status specific to the courses inside the learning plan.

Input Field Name	Data Type	Description
Learning Plan ID	Integer	The learning plan ID to filter the results by. This field is required.
User IDs	Array of Integers	The user IDs to filter the results by
Course IDs	Array of Integers	The course IDs to filter the results by
Course Types	String	The course types to filter the results by. Possible values are: `elearning` `classroom`
Enrollment Levels	String	The enrollment levels to filter the results by. Possible values are: `student` `instructor` `tutor`
Enrollment Status	String	The enrollment status to filter the results by. Possible values are: `enrolled` - Enrolled `in_progress` - In progress `completed` - Course completed `subscription_to_confirm` - The learner is yet to confirm their enrollment invitation `waiting` - Waiting `suspended` - The enrollment is suspended `overbooking` - The enrollment is overbooked
Page	Integer	The page to return. The default value is `1`.
Page size	Integer	The maximum number of results per page
Sort by	String	Set an attribute to sort the results by. Possible values are: Possible Values: `enrollment_created_at` - The enrollment creation date `course_begin_date` - The course begin date `course_end_date` - The course end date `enrollment_validity_begin_date` - The enrollment validity begin date `enrollment_validity_end_date` - The enrollment validity end date `enrollment_completion_date` - The enrollment completion date
Sorting direction	String	The sorting direction. Possible values are: `asc` - Ascending `desc` - Descending

Output Field Name	Data Type	Description
Items(List of Enrollment Records)	Array of Objects	The repeatable list of enrollment records for courses inside the Learning Plan
User ID	Integer	The ID of the enrolled user
Username	String	The user's username
Course ID	Integer	The ID of the enrolled course
Course uid	String	The unique identifier of the course
Course code	String	The code of the course
Course name	String	The name of the course
Course type	String	The type of course (for example, `elearning`, `classroom`)
Course begin date	String	The official begin date for the course content
Course end date	String	The official end date for the course content
Enrollment level	String	The user's level in the course enrollment (for example, `student`, `instructor`)
Enrollment status	String	The current status of the enrollment (for example, `enrolled`, `completed`)
Enrollment created by	Integer	The ID of the user who performed the enrollment
Enrollment created at	String	The date the enrollment was created
Enrollment validity begin date	String	The date the enrollment validity begins
Enrollment validity end date	String	The date the enrollment validity ends
Enrollment date last updated	String	The last date the enrollment status was updated
Enrollment completion date	String	The date the enrollment status became completed
Enrollment score	Integer	The score achieved in the course
Enrollment time spent	Integer	The time spent in the course (in seconds)
Count	Integer	The number of results in the current page
Has more data	Boolean	Returns `true` if there are more pages of results
Cursor	String	Cursor string for fetching the next page
Current page	Integer	The current page number
Current page size	Integer	The number of results per page returned
Total page count	Integer	The total number of pages available
Total count	Integer	The total number of all matching record
Sort (Sort Information)	Array of Objects	Details about the sorting applied to the results
Sort by	String	The attribute used for sorting
Sorting direction	String	The sorting direction

This action is equivalent to calling GET/learningplan/v1/learningplans/{learning_plan_id}/courses/enrollments.

This action does not generate a webhook event.

Batch update RSVP event

Description

Input fields

Output fields

Associated API calls

Webhooks events

Action name: Batch update RSVP event

Performs a batch update of the RSVP (Response) status for multiple users on a specific event. Required event ID and an array of user responses.

Input Field Name	Data Type	Description
Items	Array of Objects	An array where each object is a user and their RSVP response This field is required
User ID	Integer	The user ID *This field is required if the field User email* is not populated**
User email	String	The user email address *This field is required if the field User ID* is not populated**
User RSVP response	Integer	The user's response. Possible values are: `0` - Awaiting `1` - No `2` - Maybe `3` - Yes This field is required
Event ID	Integer	The ID of the event for which to update the RSVP This field is required
Synchronization timestamp	Date/Time	Timestamp to control synchronization

Output Field Name	Data Type	Description
Data	Array of Objects	An array of results for each processed user or item
Row index	Integer	The index of the item from the input array
Success	Boolean	Returns `true` if the operation for this specific item was successful
Message	String	A message detailing the result or error for the item

This action calls an internal API.

This action does not generate a webhook event.

Connector: Enrollments

Introduction

Enrollment actions supported by the connector

Get enrollments

Enroll user into a course

Enroll user into a session

Unenroll user from course

Unenroll user from session

Unenroll user from learning plan

Get Course Enrollments

Get Learning Plan Enrollments

Get Learning Plan Course Enrollments

Batch update RSVP event

Products

Education and Community

Company and contact

Legal