Webhooks Events – Docebo Help & Support

Introduction

In Docebo, you can create webhooks to trigger once an event occurs in your platform, sending you information about that event to a specific payload URL. This allows you to collect data from your learning platform to build reports, integrations, dashboards and more. You can, for example, also connect to your Human Capital Management system (HCM), email non-Docebo Learn users about actions that occur within the platform or update your Content Storage Management.

Refer to this article on Creating and Managing Webhooks on how to activate the Webhook functionality and on how to create and manage webhooks.

This article lists all of the events that can be tracked via webhooks, including a detailed description of the payloads. Events are divided into areas, for better understanding.

Events Triggering

The events managed by the Webhooks app are fired according to the platform main logic. They can be triggered by the user through the platform interface and by APIs. The same action may trigger different events because of the platform built-in logic. Please remember to check your use cases for a proper webhook configuration.

For example, you have created a webhook including the following events:

Enrollment has been updated (event name: course.enrollment.updated)
Learner completed course (event name: course.enrollment.completed)

If the user enrollment status is set to completed, the triggered event will be course.enrollment.completed and not course.enrollment.updated, despite the fact that the action triggering the event is an update.

Events Common Properties

Every event tracks specific details, but all of them have the following common properties:

Property	Description
`message_id`	a unique message id to identify the webhook
`event`	the event name that triggered the webhook
`fired_by_batch_action`	true if the event has been fired during a batch API call, false otherwise
`fired_by_background_job_hash`	background job alphanumeric unique identifier, it is displayed only when the event is generated by a background job.
`payload`	depending on the event, a different payload containing different info

If you have activated the Payload Collection option, when webhooks include more than one event, the payload webhook common property turns into payloads, indicating that the message includes more events. If you enable the payload collection feature, make sure that your endpoint system is ready to receive webhooks with two different structures.

The following is an example of a single payload, triggered because a user has been deleted:

{
  "message_id": "wh-638ce960-1363-11e9-a15d-d1c47c8f7593",
  "event": "user.deleted",
  "fired_by_batch_action": false,
  "payload": {
    "user_id": 12301,
    "deletion_date": "2019-01-08 16:35:05",
    "fired_at": "2019-01-08 16:35:05"
  }
}

Here is an example of payload collection, triggered because three users have been deleted from the platform, with a single process:

{
 "event": "user.deleted",
 "fired_by_batch_action": false,
 "message_id": "wh-d2f70d80-ab24-11ea-8467-5972fffe49aa",
 "payloads": [
   {
     "fired_at": "2020-06-10 14:15:18",
     "user_id": 13366,
     "deletion_date": "2020-06-10 14:15:18"
   },
   {
     "fired_at": "2020-06-10 14:15:18",
     "user_id": 13369,
     "deletion_date": "2020-06-10 14:15:18"
   },
   {
     "fired_at": "2020-06-10 14:15:18",
     "user_id": 13376,
     "deletion_date": "2020-06-10 14:15:18"
   }
 ]
}

Notes about Events Common Properties

The details included in each event are the same, independently from whether it is a single event or a payload collection. The webhook structure changes depending on whether the payload includes one or more events.
Some events include the user_id property to track the user performing or involved in the action tracked by the webhook. When Superadmins impersonate other users or Power Users, the tracked user_id is the ID of the impersonated user or Power User.

Events

The following is a list of all available events, divided into areas:

Assets

Asset has been deleted - contribute.deleted
Asset has been updated - contribute.updated
Asset has been uploaded - contribute.created
Invitation to watch deleted - contribute.watchinvitation.deleted

Background Jobs

Background job aborted - bj.aborted
Background job completed - bj.execution.completed
Background job created - bj.created
Background job deleted - bj.deleted
Background job execution started - bj.started

Branches

Branch has been created - branch.created
Branch has been deleted - branch.deleted
Branch has been updated - branch.updated
User assigned to a branch - branch.user.added
User removed from a branch - branch.user.removed

Channels

Channel created - channel.created
Channel deleted - channel.deleted
Channel expert added - channel.expert.added
Channel expert removed - channel.expert.removed
Channel.updated - channel.updated

Course Additional Fields

Course additional field has been deleted - courseadditionalfield.deleted

Course Catalog

Course removed from catalog - catalog.course.deleted
Learning plan removed from catalog - catalog.learningplan.deleted

Courses

Course created - course.created
Course deleted - course.deleted
Course properties have been changed - course.updated
The course has been marked as outdated - course.markedoutdated
User has rated a course - course.rating.updated

Enrollments

Enrollment has been updated - course.enrollment.updated
ILT session enrollment updated - ilt.session.enrollment.updated
Learner completed course - course.enrollment.completed
User enrolled in ILT session - ilt.session.enrollment.created
User enrolled in a course - course.enrollment.created
User unenrolled from ILT session - ilt.session.enrollment.deleted
User unenrolled from course - course.enrollment.deleted

Gamification

User earned a badge - badge.earned

ILT Sessions

ILT external calendar event changed - ilt.extcalendar.event.changed
ILT external calendar session changed - ilt.extcalendar.session.changed
ILT session changed - ilt.session.updated
ILT session deleted - ilt.session.deleted
New ILT session created - ilt.session.created

Learning Plans

Admin added a course to a Learning Plan - learningplan.course.added
Admin created a Learning Plan - learningplan.created
Admin deleted a Learning plan - learningplan.deleted
Admin removed a course from a Learning Plan - learningplan.course.removed
Admin updated a Learning Plan - learningplan.updated
Learning plan enrollment created - learningplan.enrollment.created
Learning plan enrollment deleted - learningplan.enrollment.deleted

Training Materials

An assignment has been submitted - lo.assignment.submission
An assignment tracking has been reset - lo.assignment.submission.reset
Assignment has been evaluated - lo.assignment.evaluation
Training material has been created in a course - course.trainingmaterial.created
Training material has been updated in a course - course.trainingmaterial.updated
Training material has been deleted from a course - course.trainingmaterial.deleted
Training material status has changed - trainingmaterial.playstatus.updated
Training material has been assigned to a course from the Central Repository - tmrepo.course.trainingmaterial.added
Training material coming from the Central Repository has been removed from a course - tmrepo.course.trainingmaterial.removed
Training material has been updated in the Central Repository - tmrepo.trainingmaterial.updated

Transactions

Transaction created - ecommerce.transaction.created
Transaction deleted - ecommerce.transaction.deleted
Transaction updated - ecommerce.transaction.updated

Users

Registration Request Sent - user.selfregistrationrequest.sent
Registration Confirmed - user.selfregistrationrequest.approved
User has been created - user.created
User has been deactivated - user.deactivated
User has been deleted - user.deleted
User has been modified - user.updated
User has been re-activated - user.reactivated
User registered into the platform - user.selfregistered

Asset had been deleted - contribute.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss.
`id`	asset ID
`title`	asset title

Asset has been updated - contribute.updated

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss.
`id`	asset ID
`title`	asset title
`type`	asset type. Possible values are: video, document, excel, power-point, pdf, text, other, image, audio, archive, link, drive-document, drive-sheet, drive-slide, playlist, youtube, vimeo, wistia
`visibility`	asset visibility. Possible values are: public, private
`published`	asset publication status
`extra_data`	extra data section
`description` - asset description `tags` - asset tags, both manually inserted and automatically generated by the platform artificial intelligence `id` - tag ID `text` - tag value `channels` - channel(s) where the asset has been loaded

Asset has been uploaded - contribute.created

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss.
`id`	asset ID
`title`	asset title
`type`	asset type. Possible values are: video, document, excel, power-point, pdf, text, other, image, audio, archive, link, drive-document, drive-sheet, drive-slide, playlist, youtube, vimeo, wistia
`visibility`	asset visibility. Possible values are: public, private
`published`	asset publication status
`extra_data`	extra data section
`description` - asset description `tags` - asset tags, both manually inserted and automatically generated by the platform artificial intelligence `id` - tag ID `text` - tag value `channels` - channel(s) where the asset has been loaded

Invitation to watch deleted - contribute.watchinvitation.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`id_asset`	asset ID
`invitations`	users invited to watch
`users` - IDs of the users no longer invited to watch
`channels`	channel(s) where the asset has been loaded

Background job aborted - bj.aborted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`job_hash`	background job alphanumeric unique identifier

Background job completed - bj.execution.completed

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`job_hash`	background job alphanumeric unique identifier
`errors_count`	if the background job ended with errors, the number of errors occurred

Background job created - bj.created

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`job_hash`	background job alphanumeric unique identifier
`name`	background job name, automatically assigned by the platform
`endpoint`	the API that will be used for the scheduled background job
`method`	the method used in the API call

Background job deleted - bj.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`job_hash`	background job alphanumeric unique identifier

Background job execution started - bj.started

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`job_hash`	background job alphanumeric unique identifier

Branch has been created - branch.created

Property	Description
`branch_id`	ID of the created branch
`parent_id`	ID of the branch into which the new branch has been created
`code`	Code of the new branch, or an empty string
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss.

Branch has been deleted - branch.deleted

Property	Description
`branch_id`	ID of the deleted branch
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Branch has been updated - branch.updated

Property	Description
`branch_id`	ID of the created branch
`parent_id`	ID of the branch into which the branch has been moved. Not present if the branch has not been moved
`code`	New code of the branch, can be an empty string. Not present if the code has not been changed.
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

User assigned to a branch - branch.user.added

Property	Description
`user_id`	ID of the user added to the branch
`username`	username of the user
`branch_id`	ID of the branch to which the user has been added
`branch_name`	Name of the branch to which the user has been added
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

User removed from a branch - branch.user.removed

Property	Description
`user_id`	ID of the user removed from the branch
`username`	username of the user removed from the branch
`branch_id`	ID of the branch from which the user has been removed
`branch_name`	Name of the branch from which the user has been removed
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Channel created - channel.created

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`channel_id`	ID of the newly created channel
`title`	channel name
`language`	channel language
`upload_permissions`	who is allowed to upload content in the channel. Possible values are: everyone, peer_review, experts_only
`enabled`	whether the channel is shown or not. Possible values are: true, false
`creation_date`	channel creation date in UTC with the following format YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`description` - channel description `visibility` - channel visibility `all` - channel is visible for all users `groups` - channel is visible for the selected groups `branches` - channel is visible for the selected branches `id` - branch ID `descendants` - branch descendants included or not

Channel deleted - channel.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`channel_id`	ID of the deleted channel
`title`	channel name
`language`	channel language
`upload_permissions`	who is allowed to upload content in the channel. Possible values are: everyone, peer_review, experts_only
`enabled`	whether the channel is shown or not. Possible values are: true, false
`deletion_date`	channel deletion date in UTC with the following format YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section

Channel expert added - channel.expert.added

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`user_id`	expert ID
`channel_id`	ID of the channel associated with the expert
`extra_data`	extra data section

Channel expert removed - channel.expert.removed

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`user_id`	expert ID
`channel_id`	ID of the channel associated with the expert
`extra_data`	extra data section

Channel updated - channel.updated

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`channel_id`	ID of the updated channel
`title`	channel name
`language`	channel language
`upload_permissions`	who is allowed to upload content in the channel. Possible values are: everyone, peer_review, experts_only
`enabled`	whether the channel is shown or not. Possible values are: true, false
`update_date`	channel update date in UTC with the following format YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`description` - channel description `visibility` - channel visibility `all` - channel is visible for all users `groups` - channel is visible for the selected groups `branches` - channel is visible for the selected branches `id` - branch ID `descendants` - branch descendants included or not

Course created - course.created

Property	Description
`course_id`	ID of the course
`name`	name of the course
`type`	the type of course. It can be “elearning”, “classroom”, “webinar”
`code`	code of the course (it can be empty or null)
`creation_date`	date of the creation (in YYYY-MM-DD hh:mm:ss UTC)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`start_date`	course start date
`end_date`	course end date
`language`	course language
`duration`	course duration, expressed in seconds
`extra_data`	extra data section
`self_enrollment_policy` - type of self-enrollment currently set. Possible options are: “disabled”, “admin_approval”, “free” `self_unenrollment_policy` - self-unenrollment setting. Possible values are: “disabled”, “on_course_not_completed”, “even_on_course_completed” `allow_session_self_unenrollment`- whether the user can self-unenroll from the course session `course_rating_permission`- identifies if the user is allowed to rate the course. Possible values are: “disabled”, “always”, “if_enrolled”, “on_completion” `credits`- number of credits assigned to course `description` - course description `provider` - course CSP, needed only when the course has been imported from an external catalog

Course deleted - course.deleted

Property	Description
`course_id`	ID of the course
`name`	name of the course
`type`	the type of course. It can be “elearning”, “classroom”, “webinar”
`code`	code of the course (it can be empty or null)
`deletion_date`	date of the deletion (in YYYY-MM-DD hh:mm:ss UTC)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`start_date`	course start date
`end_date`	course end date
`language`	course language
`duration`	course duration, expressed in seconds

Course properties have been changed - course.updated

Property	Description
`course_id`	ID of the course
`name`	name of the course
`type`	the type of course. It can be “elearning”, “classroom”, “webinar”
`code`	code of the course (it can be empty or null)
`update_date`	date of the update (in YYYY-MM-DD hh:mm:ss UTC)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`start_date`	course start date
`end_date`	course end date
`language`	course language
`duration`	course duration, expressed in seconds
`extra_data`	extra data section
`self_enrollment_policy` - type of self-enrollment currently set. Possible options are: “disabled”, “admin_approval”, “free” `self_unenrollment_policy` - self-unenrollment setting. Possible values are: “disabled”, “on_course_not_completed”, “even_on_course_completed” `allow_session_self_unenrollment`- whether the user can self-unenroll from the course session `course_rating_permission` - identifies if the user is allowed to rate the course. Possible values are: “disabled”, “always”, “if_enrolled”, “on_completion” `credits` - number of credits assigned to the course `description` - course description `provider` - course CSP, needed only when the course has been imported from an external catalog

The course has been marked as outdated - content.markedoutdated

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`course_id`	ID of the rated course
`user_id`	ID of the user who rated the course
`number_of_reports`	number of times the course has been marked as outdated

User has rated a Course - course.rating.updated

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`course_id`	ID of the rated course
`user_id`	ID of the user who rated the course
`user_rating`	rating value
`average_rating`	average course rating, including the current user rating
`number_of_votes`	number of ratings received by the course

Enrollment has been updated - course.enrollment.updated

Property	Description
`user_id`	ID of the user enrolled
`course_id`	ID of the course to which the user is enrolled
`status`	A string that represents the new enrollment status. Possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`level`	user level in the course, possible values are: "learner", "instructor", "tutor"
`enrollment_date`	date when the enrollment was recorded in UTC in YYYY-MM-DD HH:mm:ss
`enrollment_date_begin_validity`	date when the enrollment validity starts, in UTC in YYYY-MM-DD HH:mm:ss
`enrollment_date_end_validity`	date when the enrollment validity starts, in UTC in YYYY-MM-DD HH:mm:ss
`subscribed_by_id`	ID of the user enrolling the user identified by the user_id parameter
`extra_data`	extra data section
`score` - user score in the course `additional_fields` - enrollment additional fields `language` - course language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

ILT session enrollment updated - ilt.session.enrollment.updated

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`user_id`	ID of the user
`course_id`	ID of the course
`session_id`	ID of the ILT session associated with the course
`session_name`	the name of the session in which the user has been enrolled
`level`	the enrollment level of the user (learner, tutor, instructor, coach)
`enrollment_date`	date of the enrollment
`enrollment_date_begin_validity`	start of the validity period for the enrollment (it can be null)
`enrollment_date_end_validity`	end of the validity period (it can be null)
`subscribed_by_id`	ID of the Superadmin or Power User who enrolled the user, or the user ID if the user enrolled by him/herself.
`status`	enrollment status. Enrollment status. Possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”.
`extra_data`	extra data section
`additional_fields` - enrollment additional fields `language` - course language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

Learner completed course - course.enrollment.completed

Property	Description
`user_id`	ID of the user
`course_id`	ID of the course
`completion_date`	date of the completion
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`level`	user level in the course, possible values are: “learner”, “instructor”, “tutor”
`subscribed_by_id`	ID of the user enrolling the user identified by the user_id parameter
`status`	enrollment status, possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”
`enrollment_date`	date when the enrollment was recorded in UTC in YYYY-MM-DD HH:mm:ss
`enrollment_date_begin_validity`	date when the enrollment validity starts, in UTC in YYYY-MM-DD HH:mm:ss
`enrollment_date_end_validity`	date when the enrollment validity ends, in UTC in YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`total_time` - time spent by the user on the course `score` - user score in the course `additional_fields` - enrollment additional fields `language` - course language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

User enrolled in ILT session - ilt.session.enrollment.created

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`user_id`	ID of the user
`course_id`	ID of the course
`session_id`	ID of the ILT session associated with the course
`session_name`	the name of the session in which the user has been enrolled
`level`	the enrollment level of the user (learner, tutor, instructor, coach)
`enrollment_date`	date of the enrollment
`enrollment_date_begin_validity`	start of the validity period for the enrollment (it can be null)
`enrollment_date_end_validity`	end of the validity period (it can be null)
`subscribed_by_id`	ID of the Superadmin or Power User who enrolled the user, or the user ID if the user enrolled by him/herself.
`status`	enrollment status. Enrollment status. Possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”.
`extra_data`	extra data section
`additional_fields` - enrollment additional fields `language` - course language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

User enrolled in a course - course.enrollment.created

Property	Description
`user_id`	ID of the user
`username`	username of the user
`course_id`	ID of the course
`course_name`	course title
`level`	the enrollment level of the user (learner, tutor, instructor, coach)
`enrollment_date`	date of the enrollment
`enrollment_date_begin_validity`	start of the validity period for the enrollment (it can be null)
`enrollment_date_end_validity`	end of the validity period (it can be null)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`subscribed_by_id`	ID of the Superadmin or Power User who enrolled the user, or the user ID if the user enrolled by him/herself.
`status`	Enrollment status. Possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”.
`extra_data`	extra data section
`score` - user score in the course `additional_fields` - enrollment additional fields `language` - course language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

User unenrolled from course - course.enrollment.deleted

Property	Description
`user_id`	ID of the user enrolled
`username`	username of the user
`course_id`	ID of the course to which the user is enrolled
`course_name`	title of the course to which the user is enrolled
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`level`	user level in the course, possible values are: “learner”, “instructor”, “tutor”
`enrollment_date`	date when the enrollment was recorded in UTC in YYYY-MM-DD HH:mm:ss
`enrollment_date_begin_validity`	date when the enrollment validity starts, in UTC in YYYY-MM-DD HH:mm:ss
`enrollment_date_end_validity`	date when the enrollment validity starts, in UTC in YYYY-MM-DD HH:mm:ss
`subscribed_by_id`	ID of the user enrolling the user identified by the user_id parameter
`status`	enrollment status, possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”
`extra_data`	extra data section
`total_time` - time spent by the user on the course

User earned a badge - badge.earned

Property	Description
`fired_at`	The date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`id_badge`	The badge ID
`id_user`	The user ID
`score`	The total score attained
`issued_on`	The date and time the badge was issued in UTC with the following format YYYY-MM-DD HH:mm:ss
`event_type`	The type of the event. Possible values are: LMS Badges StudentCompletedCourse - Learner completed course StudentCompletedLO - Learner completed training material NewReply - Learner posted a reply on a forum discussion NewThread - Learner started a new discussion in a forum NewHelpfulFeedback - Learner clicked "Helpful" NewToneFeedback - Learner clicked "Rate" StudentCompletedLearningPlan - Learner completed a Learning Plan Discover, Coach & Share Badges UserReachedAGoal - User met a goal AssetReachedAGoal - User's asset met a goal AssetViewedForLongestTime - User's asset viewed for the longest duration of time ExpertReachedAGoal - Expert met a goal UserReachedAGoalAsTopContributor - User became a top contributor (uploaded assets)
`badge_name`	The name of the badge
`badge_image`	The URL of the image of the badge
`is_shareable`	A boolean value indicating if the badge can be shared

User unenrolled from an ILT session - ilt.session.enrollment.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`user_id`	ID of the user
`course_id`	ID of the course
`session_id`	ID of the ILT session associated with the course
`session_name`	the name of the session in which the user has been enrolled
`level`	the enrollment level of the user (learner, tutor, instructor, coach)
`enrollment_date`	date of the enrollment
`enrollment_date_begin_validity`	start of the validity period for the enrollment (it can be null)
`enrollment_date_end_validity`	end of the validity period (it can be null)
`subscribed_by_id`	ID of the Superadmin or Power User who enrolled the user, or the user ID if the user enrolled by him/herself
`status`	Enrollment status. Possible values are: “subscribed”, “in_progress”, “completed”, “waiting”, “subscription_to_confirm”, “suspended”, “overbooking”

ILT external calendar event changed - ilt.extcalendar.event.changed

This webhook is for use by specific Docebo Connect recipes only and should not be used for any other purposes.

ILT external calendar session changed - ilt.extcalendar.session.changed

This webhook is for use by specific Docebo Connect recipes only and should not be used for any other purposes.

ILT session changed - ilt.session.updated

Property	Description
`course_id`	ID of the course associated with the updated ILT session
`course_code`	code of the course associated with the updated ILT session
`session_id`	ID of the updated ILT session
`session_code`	code of the updated ILT session
`session_name`	name of the updated ILT session
`extra_data`	extra data section
`session_description` - description of the updated ILT session `session_maximum_enrollments` - maximum number of enrollments allowed for the updated ILT session `session_minimum_enrollments` - minimum number of enrollments allowed for the updated ILT session `last_subscription_date` - last date for enrolling into the ILT session `dates` `name` - name of the updated ILT session `original_date` - date of the updated ILT session `original_timezone`- timezone set of the updated session `date_time_start` - starting time set for the updated session `date_time_end` - end time set for the updated session `break_date_time_start` - breaking starting time for the updated session `break_date_time_end` - breaking end time for the updated session `location_name` - name of the location where the session will be held `location_country` - Country where the session will be held `classrom_name` - name of the classroom where the session will be held `additional_fields` - session additional fields `language` - session language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

ILT session deleted - ilt.session.deleted

Property	Description
`course_id`	ID of the course associated with the deleted ILT session
`course_code`	code of the course associated with the deleted ILT session
`session_id`	ID of the deleted ILT session
`session_code`	code of the deleted ILT session
`session_name`	name of the deleted ILT session

New ILT session created - ilt.session.created

Property	Description
`course_id`	ID of the course associated with the ILT session
`course_code`	code of the course associated with the ILT session
`session_id`	ID of the newly created ILT session
`session_code`	code of the newly created ILT session
`session_name`	name of the newly created ILT session
`extra_data`	extra data section
`session_description` - description of the newly created ILT session `session_maximum_enrollments` - maximum number of enrollments allowed for the newly created ILT session `session_minimum_enrollments` - minimum number of enrollments allowed for the newly created ILT session `last_subscription_date` - last date for enrolling into the ILT session `dates` `name` - name of the newly created ILT session `original_date` - date of the newly created ILT session `original_timezone` - timezone set of the newly created session `date_time_start` - starting time set for the newly created session `date_time_end` - end time set for the newly created session `break_date_time_start` - breaking starting time for the newly created session `break_date_time_end` - breaking end time for the newly created session `location_name` - name of the location where the session will be held `location_country` - Country where the session will be held `classrom_name` - name of the classroom where the session will be held `additional_fields` - session additional fields `language` - session language `list` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

Admin added a course to a Learning Plan - learningplan.course.added

Property	Description
`learning_plan_id`	ID of the learning plan
`course_id`	ID of the course added to the learning plan
`course_name`	name of the course added to the learning plan
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Admin created a Learning Plan - learningplan.created

Property	Description
`learning_plan_id`	ID of the learning plan
`name`	name of the learning plan
`code`	code of the learning plan (it can be empty or null)
`creation_date`	date of the creation (in YYYY-MM-DD hh:mm:ss UTC)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`description` - learning plan description

Admin deleted a Learning plan - learningplan.deleted

Property	Description
`learning_plan_id`	ID of the learning plan
`name`	name of the learning plan
`code`	code of the learning plan (it can be empty or null)
`deletion_date`	date of the deletion (in YYYY-MM-DD hh:mm:ss UTC)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Admin removed a course from a Learning Plan - learningplan.course.removed

Property	Description
`learning_plan_id`	ID of the learning plan
`course_id`	ID of the course removed from the learning plan
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Admin updated a Learning Plan - learningplan.updated

Property	Description
`learning_plan_id`	ID of the learning plan
`name`	name of the learning plan
`code`	code of the learning plan (it can be empty or null)
`update_date`	date of the update (in YYYY-MM-DD hh:mm:ss UTC)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`description` - learning plan description

Learning plan enrollment created - learningplan.enrollment.created

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`user_id`	ID of the enrolled user
`username`	username of the enrolled user
`learning_plan_id`	ID of the course
`learning_plan_name`	course title
`learning_plan_code`	learning plan code
`enrollment_date`	date of the enrollment in YYYY-MM-DD HH:mm:ss format
`subscribed_by_id`	ID of the Superadmin or Power User who enrolled the user, or the user ID if the user enrolled by him/herself.
`enrollment_date_begin_validity`	the start of the validity period for the enrollment (it can be null)
`enrollment_date_end_validity`	the end of the validity period (it can be null)
`extra_data`	extra data section
`description` - Description of the learning plan

Learning plan enrollment deleted - learningplan.enrollment.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`user_id`	ID of the enrolled user
`username`	username of the enrolled user
`learning_plan_id`	ID of the course

An assignment has been submitted - lo.assignment.submission

Property	Description
`submission_id`	ID of the assignment submission created by the learner
`creation_date`	date and time when the submission was generated in UTC with format: YYYY-MM-DD HH:ii:ss
`user_id`	ID of the learner submitting the assignment
`lo_id`	ID of the assignment training material
`lo_name`	name of the assignment training material
`name`	title for the submission, as defined by the learner
`description`	comments added by learner along with the submission
`course_id`	ID of the course where the assignment training material was created
`files`	one or more uploaded files
`url` - hashed filename generated by the platform `filename` - original file name, as defined by the learner
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

An assignment tracking has been reset - lo.assignment.submission.reset

Property	Description
`submission_id`	ID of the assignment submission created by the learner
`user_id`	ID of the learner submitting the assignment
`lo_id`	ID of the assignment training material
`lo_name`	name of the assignment training material
`name`	title for the assignment submission as given by the learner
`description`	comments added by learner along with the submission
`creation_date`	date when the assignment was submitted in UTC with the following format: YYYY-MM-DD HH:ii:ss
`course_id`	ID of the course where the assignment training material was created
`files`	one or more uploaded files
`url` - hashed assignment filename `filename` - original filename as uploaded by the learner
`fired_at`	timestamp when the assignment was submitted in UTC with the following format: YYYY-MM-DD HH:ii:ss

Assignment has been evaluated - lo.assignment.evaluation

Property	Description
`submission_id`	ID of the assignment submission evaluated by the instructor
`user_id`	ID of the learner in evaluation by the instructor
`lo_id`	ID of the assignment training material
`lo_name`	the name of the training material of type assignment
`course_id`	ID of the course where the assignment training material was created
`score`	score given by the instructor. Default = “0”. Allowed range 0 - 100
`comment`	evaluation comments written by the instructor
`allow_reupload`	set whether the learner is allowed to submit again the assignment, when failed. Default = true
`status`	Evaluation status. Possible values: “failed”, “passed”
`url`	hashed filename of the instructor’s evaluation report
`filename`	original filename, as uploaded by the instructor
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`instructor_id`	ID of the instructor that evaluated this assignment.

Training material has been created in a course - course.trainingmaterial.created

Property	Description
`user_id`	ID of the user who created the training material
`username`	username of the user who created the training material
`course_id`	ID of the course where the training material was created
`course_name`	title of the course where the training material was created
`training_material_name`	title of the newly created training material
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the newly created training material

Training material has been updated in a course - course.trainingmaterial.updated

Property	Description
`user_id`	ID of the user who updated the training material
`username`	username of the user who updated the training material
`course_id`	ID of the course where the training material was updated
`course_name`	title of the course where the training material was updated
`training_material_name`	title of the updated training material
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the updated training material
`user_play_count`	Number of users who played the training material
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Training material has been deleted from a course - course.trainingmaterial.deleted

Property	Description
`user_id`	ID of the user who deleted the training material
`username`	username of the user who deleted the training material
`course_id`	ID of the course from where the training material was deleted
`course_name`	title of the course from where the training material was deleted
`training_material_name`	title of the deleted training material
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the deleted created training material
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Training material status has changed - trainingmaterial.playstatus.updated

Property	Description
`user_id`	ID of the user whose action changed the status of the training material
`username`	username of the user whose action changed the status of the training material
`course_id`	ID of the course where the status of the training material changed
`course_name`	title of the training material with changed status
`course_type`	type of course to which the training material with changed status. Possible values are: elearning, classroom
`training_material_name`	title of the training material with changed status
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the training material with changed status
`training_material_status`	new status of the training material. Possible values are: not_started, in_progress, failed, completed
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Training material has been assigned to a course from the Central Repository - tmrepo.course.trainingmaterial.added

Property	Description
`user_id`	ID of the user who assigned the training material to the course from the Central Repository
`username`	username of the user who assigned the training material to the course from the Central Repository
`course_id`	ID of the course to which the training material was assigned from the Central Repository
`course_name`	title of the course to which the training material was assigned from the Central Repository
`course_type`	type of course to which the training material was assigned from the Central Repository. Possible values are: elearning, classroom
`training_material_name`	title of the training material assigned to the course from the Central Repository
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the training material assigned to the course from the Central Repository
`training_material_version_id`	version ID of the training material assigned to the course from the Central Repository
`training_material_version_name`	version name of the training material coming from the Central Repository that was removed from the course
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Training material coming from the Central Repository has been removed from a course - tmrepo.course.trainingmaterial.removed

Property	Description
`user_id`	ID of the user who removed the training material coming from the Central Repository from the course
`username`	username of the user who removed the training material coming from the Central Repository from the course
`course_id`	ID of the course from which the training material coming from the Central Repository was removed
`course_name`	title of the course from which the training material coming from the Central Repository was removed
`course_type`	type of course from which the training material coming from the Central Repository was removed. Possible values are: elearning, classroom
`training_material_name`	title of the training material coming from the Central Repository that was removed from the course
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the training material coming from the Central Repository that was removed from the course
`training_material_version_id`	version ID of the training material coming from the Central Repository that was removed from the course
`training_material_version_name`	version name of the training material assigned to the course from the Central Repository
`user_play_count`	Number of users who played the training material
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Training material has been updated in the Central Repository - tmrepo.trainingmaterial.updated

Property	Description
`user_id`	ID of the user who updated the training material in the Central Repository
`username`	username of the user who updated the training material in the Central Repository
`training_material_name`	title of the training material updated in the Central Repository
`training_material_type`	the type of training material. Possible values are: scorm, aicc, tincan_xapi, video, file, assignment, elucidat, google_drive, lti, otj, slides_converter, html, survey, test
`training_material_id`	ID of the training material updated in the Central Repository
`assigned_courses_count`	number of courses the updated training material is assigned to
`versions_count`	number of the training material version updated in the Central Repository
`users_play_count`	number of users who played the training material
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Transaction created - ecommerce.transaction.created

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`transaction_id`	transaction ID, automatically assigned by the platform
`user_id`	ID of the user who executed the transaction
`transaction_date`	transaction date and time in UTC in the following format: yyyy-dd-mm hh:mm:ss
`payment_type`	payment type used to settle the transaction payment
`external_transaction_id`	transaction ID on payment gateway side (not always present)
`payment_status`	payment status. Possible values are: successful, failed, pending, canceled
`total_paidamount`	total amount paid for the transaction
`currency`	currency used to settle the transaction

Transaction deleted - ecommerce.transaction.deleted

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`transaction_id`	transaction ID, automatically assigned by the platform
`user_id`	ID of the user who executed the transaction
`transaction_date`	transaction date and time in UTC in the following format: yyyy-dd-mm hh:mm:ss
`payment_type`	payment type used to settle the transaction payment
`external_transaction_id`	transaction ID on payment gateway side (not always present)
`payment_status`	payment status, always set to cancelled
`total_paidamount`	total amount paid for the transaction

Transaction updated - ecommerce.transaction.updated

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`transaction_id`	transaction ID, automatically assigned by the platform
`user_id`	ID of the user who executed the transaction
`transaction_date`	transaction date and time in UTC in the following format: yyyy-dd-mm hh:mm:ss
`payment_type`	payment type used to settle the transaction payment
`external_transaction_id`	transaction ID on payment gateway side (not always present)
`payment_status`	payment status, always set to cancelled
`total_paidamount`	total amount paid for the transaction

Registration Request Sent - user.selfregistrationrequest.sent

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`user_id`	ID of the user requesting to self-register in the platform
`username`	username of the user requesting to self-register in the platform
`level`	level of the user requesting to self-register
`email`	email of the user requesting to self-register
`firstname`	first name of the user requesting to self-register
`lastname`	last name of the user requesting to self-register

Registration Confirmed - user.selfregistrationrequest.approved

Property	Description
`fired_at`	date and time of the moment the event has been fired in UTC with the following format YYYY-MM-DD HH:mm:ss
`user_id`	ID of the user requesting to self-register
`username`	username of the user requesting to self-register
`level`	level of the user requesting to self-register
`email`	email of the user requesting to self-register
`approval_time`	timestamp when the Superadmin approves the user self-registration, with the following format: YYYY-MM-DD HH:mm:ss
`firstname`	first name of the user requesting to self-register
`lastname`	last name of the user requesting to self-register

User has been created - user.created

Property	Description
`user_id`	the newly created ID for the new user
`username`	username of the new user
`email`	the email for the newly created user (it can be null or empty)
`creation_date`	the date of creation for the user, in format YYYY-MM-DD HH:mm:ss UTC
`expiration_date`	the date of expiration for the user, in format YYYY-MM-DD HH:mm:ss UTC format
`level`	the level of the user created (superadmin, poweruser, user)
`firstname`	the first name of the user (it can be null)
`lastname`	the last name of the user (it can be null)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`provisioned`	(can be null) Identity Provider (IdP) with which the newly created user has been provisioned. Possible values: “saml” (if the user was provisioned using SAML); “null” (if the user was manually created or was provisioned with an IdP different from SAML)
`extra_data`	extra data section
`additional_fields` - additional field language in the platform default language `language` - fields language `List` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

User has been deactivated - user.deactivated

Property	Description
`user_id`	the newly created id for the new user
`username`	username of the user
`email`	the email for the newly created user (it can be null or empty)
`deactivation_date`	the date of the deactivation of the user, in format YYYY-MM-DD HH:mm:ss UTC
`expiration_date`	the date of expiration for the user, in format YYYY-MM-DD HH:mm:ss UTC format
`level`	the level of the created user
`firstname`	the first name of the user (it can be null or empty)
`lastname`	the last name of the user (it can be null or empty)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`additional_fields` - additional field language in the platform default language `language` - fields language `List` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

User has been deleted - user.deleted

Property	Description
`user_id`	the ID of the deleted user
`username`	username of the deleted user
`deletion_date`	the date of deletion of the user, in format YYYY-MM-DD HH:mm:ss UTC
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

User has been modified - user.updated

Property	Description
`user_id`	the newly created id for the new user
`username`	username of the new user
`email`	the email for the newly created user (it can be null or empty)
`update_date`	the date of update for the user, in format YYYY-MM-DD HH:mm:ss UTC
`expiration_date`	the date of expiration for the user, in format YYYY-MM-DD HH:mm:ss UTC format
`level`	the level of the created user
`firstname`	the first name of the user (it can be null or empty)
`lastname`	the last name of the user (it can be null or empty)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss
`extra_data`	extra data section
`additional_fields` - additional field language in the platform default language `language` - fields language `List` `id` - additional field ID `name` - additional field name, in the platform default language defined in the Localization Tool `value` - additional field value

User has been re-activated - user.reactivated

Property	Description
`user_id`	ID of the reactivated user
`username`	username of the reactivated user
`email`	email of the reactivated user (it can be null or empty)
`reactivation_date`	date when the user is reactivated, in YYYY-MM-DD HH:mm:ss UTC format
`expiration_date`	the date of expiration for the user, in format YYYY-MM-DD HH:mm:ss UTC format
`level`	level of the reactivated user
`firstname`	first name of the reactivated user (it can be null or empty)
`lastname`	last name of the reactivated user (it can be null or empty)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

User registered into the platform - user.selfregistered

Property	Description
`user_id`	the newly created ID for the new user
`username`	the username of the new user
`email`	the email for the newly created user (it can be null or empty)
`creation_date`	the date of creation for the user, in format YYYY-MM-DD HH:mm:ss UTC
`level`	the level of the user created (superadmin, poweruser, user)
`firstname`	the first name of the user (it can be null or empty)
`lastname`	the last name of the user (it can be null or empty)
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Course additional field has been deleted - courseadditionalfield.deleted

Property	Description
`additional_field_id`	ID of the deleted additional field
`course_type`	type of the course from which the additiona field was deleted. Possible values are: elearning, ilt
`type`	the type of additional field. Possible values are: date, dropdown, textfield, textarea, accrediframe
`name`	name of the deleted additional field
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Course removed from catalog - catalog.course.deleted

Property	Description
`catalog_id`	ID of the catalog from where the course was deleted
`course_id`	ID of the course deleted from the catalog
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Learning plan removed from catalog - catalog.learningplan.deleted

Property	Description
`catalog_id`	ID of the catalog from where the learning plan was deleted
`learning_plan_id`	ID of the learning plan deleted from the catalog
`fired_at`	date and time of the moment the event has been fired in UTC in YYYY-MM-DD HH:mm:ss

Docebo Help

How can we help?