Skip to main content

Docebo Help

How can we help?

Webhooks events

Last updated
Docebo module
  • API
Reading time
User level
  • Administrators

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
webhook_id the unique identifier of the webhook
original_domain the domain of the platform where the webhook originated
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",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "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",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "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

Background Jobs

Branches

Central repository

Certifications

Channels

Course additional fields

 

Course catalog

Courses

Enrollments

Gamification

 

ILT sessions

Learning plans

Skills

 

Training materials

Transactions

Users

Asset had been deleted contribute.deleted

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
id The asset ID.
title The asset title.

Asset has been updated contribute.updated

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
id The asset ID.
title The asset title.
type

The 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

The asset visibility. Possible values are:

  • public
  • private
published The asset publication status.
extra_data The extra data section.
  • description - Asset description
  • tags - Asset tags, both manually inserted and automatically generated by the platform's artificial intelligence
    • id - Tag ID
    • text - Tag value
  • channels - Channels where the asset has been loaded

Asset has been uploaded contribute.created

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
id The asset ID.
title The asset title.
type

The 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

The asset visibility. Possible values are:

  • public
  • private
published The asset publication status.
extra_data The extra data section.
  • description - Asset description
  • tags - Asset tags, both manually inserted and automatically generated by the platform's artificial intelligence
    • id - Tag ID
    • text - Tag value
  • channels - Channels where the asset has been loaded

Invitation to watch deleted contribute.watchinvitation.deleted

Property Description
fired_at

The date and time of the moment the event has been fired in UTC

Format:

YYYY-MM-DD HH:mm:ss
id_asset The asset ID.
invitations The users invited to watch.
users The IDs of the users no longer invited to watch.
channels The channels where the asset has been loaded.

Background job aborted bj.aborted

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
job_hash The background job alphanumeric unique identifier.

Background job completed bj.execution.completed

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
job_hash The 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

The date and time of the moment the event has been fired in UTC

Format:

YYYY-MM-DD HH:mm:ss
job_hash The background job alphanumeric unique identifier.
name The background job name, automatically assigned by the platform.
endpoint The API call 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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
job_hash The background job alphanumeric unique identifier.

Background job execution started bj.started

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
job_hash The 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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Branch has been deleted branch.deleted

Property Description
branch_id ID of the deleted branch.
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

User assigned to a branch branch.user.added

Property Description
user_id ID of the user assigned to the branch.
username Username of the user.
branch_id ID of the branch to which the user has been assigned.
branch_name Name of the branch to which the user has been assigned.
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Training material pushed to course 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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Training material removed from 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

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Training material updated material 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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Certification awarded certification.award.awarded

Tip: This webhook is intended for use with external certification providers and is designed to be used only in conjunction with Docebo Connect.

Property Description
fired_at The date and time of the moment the event has been fired in UTC.
Format:
YYYY-MM-DD HH:mm:ss
certification_id The ID of the certification.
user_id The ID of the user.
issue_date The issue date.
Format:
YYYY-MM-DD
expiration_date The expiration date. Use null for no expiration date.
Format:
YYYY-MM-DD
always_valid Returns 1 if always valid, otherwise returns 0.
association_type The type the certification is associated with.
Example:
external_integration
certification_user_id The user ID of the certification in the externally integrated platform.

Example payload:

{
  "event": "certification.award.awarded",
  "fired_by_batch_action": false,
  "message_id": "wh-366d69b0-b5f1-11ee-89d3-e3991e9d4525",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "payload": {
    "fired_at": "2024-01-18 11:03:28",
    "certification_id": 1,
    "user_id": 100,
    "issue_date": "2024-01-16",
    "expiration_date": null,
    "always_valid": 1,
    "association_type": "external_integration",
    "certification_user_id": 140
  }
}

Certification revoked certification.award.revoked

Tip: This webhook is intended for use with external certification providers and is designed to be used only in conjunction with Docebo Connect.

Property Description
fired_at The date and time of the moment the event has been fired in UTC.
Format:
YYYY-MM-DD HH:mm:ss
certification_id The ID of the certification.
user_id The ID of the user.
issue_date The issue date.
Format:
YYYY-MM-DD
expiration_date The expiration date. Use null for no expiration date.
Format:
YYYY-MM-DD
always_valid Returns 1 if always valid, otherwise returns 0.
association_type The type the certification is associated with.
Example:
external_integration
certification_user_id The user ID of the certification in the externally integrated platform.

Example payloads:

{
  "event": "certification.award.revoked",
  "fired_by_batch_action": false,
  "message_id": "wh-ad70bb50-b6bb-11ee-ac50-7561ccd0056e",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "payload": {
    "fired_at": "2024-01-19 11:12:46",
    "certification_id": 123,
    "user_id": 1,
    "issue_date": "2024-01-16",
    "expiration_date": null,
    "always_valid": 1,
    "association_type": "external_integration",
    "certification_user_id": "1000"
  }
}

Example with multiple payloads:

{
  "event": "certification.award.revoked",
  "fired_by_batch_action": false,
  "message_id": "wh-ab6569c0-b5f1-11ee-89d3-e3991e9d4525",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "payloads": [
    {
      "fired_at": "2024-01-18 11:06:44",
      "certification_id": 123,
      "user_id": 1,
      "issue_date": "2024-01-16",
      "expiration_date": null,
      "always_valid": 1,
      "association_type": "external_integration",
      "certification_user_id": 1000
    },
    {
      "fired_at": "2024-01-18 11:06:44",
      "certification_id": 123,
      "user_id": 2,
      "issue_date": "2024-01-16",
      "expiration_date": "2024-01-23",
      "always_valid": 0,
      "association_type": "external_integration",
      "certification_user_id": 2000
    }
  ]
}

Certification updated certification.award.updated

Tip: This webhook is intended for use with external certification providers and is designed to be used only in conjunction with Docebo Connect.

Property Description
fired_at The date and time of the moment the event has been fired in UTC.
Format:
YYYY-MM-DD HH:mm:ss
certification_id The ID of the certification.
user_id The ID of the user.
issue_date The updated issue date.
Format:
YYYY-MM-DD
issue_date_old The previous issue date.
Format:
YYYY-MM-DD
expiration_date The updated expiration date or null for no expiration date.
Format:
YYYY-MM-DD
expiration_date_old The previous expiration date or null for no expiration date.
Format:
YYYY-MM-DD
always_valid Returns 1 if always valid, otherwise returns 0.
always_valid_old The previous value for always_valid; returns 1 if it was always valid, otherwise returns 0.
association_type The type the certification is associated with.
Example:
external_integration
certification_user_id The user ID of the certification in the externally integrated platform.

Example payload:

{
  "event": "certification.award.updated",
  "fired_by_batch_action": false,
  "message_id": "wh-c4e72d30-e516-11ee-97d3-3b0acad5c01f",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "payload": {
    "fired_at": "2024-03-18 11:00:41",
    "certification_id": 2,
    "user_id": 13107,
    "issue_date": "2023-01-12",
    "issue_date_old": "2023-01-12",
    "expiration_date": "2024-01-12",
    "expiration_date_old": "2024-01-12",
    "always_valid": 0,
    "always_valid_old": 0,
    "association_type": "manual"
  }
}

Channel created channel.created

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

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 to 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

The channel creation date in UTC.

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

The date and time of the moment the event has been fired in UTC.

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 to 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

The channel deletion date in UTC

Format:

YYYY-MM-DD HH:mm:ss
extra_data Extra data section.

Channel expert added channel.expert.added

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

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

The date and time of the moment the event has been fired in UTC.

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

The date and time of the moment the event has been fired in UTC.

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 to 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

The channel update date in UTC.

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 Course title.
type

Type of course.

Possible values are

  • elearning
  • classroom
  • webinar
code Course code (can be empty or null).
creation_date

The date of the creation in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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.

Course deleted course.deleted

Property Description
course_id ID of the course.
name Title of the course.
type

Type of course.

Possible values are:

  • elearning
  • classroom
  • webinar
code Course code (can be empty or null).
deletion_date

The date of the deletion in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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 Title of the course.
type

Type of course.

Possible values are:

  • elearning
  • classroom
  • webinar
code Course code (can be empty or null).
update_date

The date of the update in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
course_id ID of the course marked as outdated.
user_id ID of the user who marked as outdated.
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

The date and time of the moment the event has been fired in UTC.

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
level

User level in the course.

Possible values are:

  • learner
  • instructor
  • tutor
enrollment_date

The date when the enrollment was recorded, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
enrollment_date_begin_validity

The date when the enrollment validity starts, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
enrollment_date_end_validity

The date when the enrollment validity starts, in UTC

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

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 Name of the session in which the user has been enrolled.
level

The enrollment level of the user.

Possible values are:

  • learner
  • tutor
  • instructor
  • coach
enrollment_date Date of the enrollment.
enrollment_date_begin_validity Start of the validity period for the enrollment (can be null).
enrollment_date_end_validity End of the validity period (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 themself.
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 completion.
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The date when the enrollment was recorded in UTC.

Format:

YYYY-MM-DD HH:mm:ss
enrollment_date_begin_validity

The date when the enrollment validity starts, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
enrollment_date_end_validity

The date when the enrollment validity ends, in UTC.

Format:

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
      • nameAdditional field name, in the platform default language defined in the Localization tool.
      • value - additional field value

Example payload:

{
  "event":"course.enrollment.completed",
  "fired_by_batch_action":false,
  "message_id":"wh-20240318-056045-baf44a12-722b-4de1-a631-1a68938be6e9",
  "webhook_id":11,
  "original_domain":"example-domain.docebosaas.com",
  "payload":{
    "fired_at":"2024-03-18 09:00:45",
    "user_id":13827,
    "course_id":146,
    "completion_date":"2024-03-18 09:00:44",
    "subscribed_by_id":13827,
    "status":"completed",
    "level":"learner",
    "enrollment_date":"2022-04-22 10:21:28",
    "enrollment_date_begin_validity":null,
    "enrollment_date_end_validity":null,
    "extra_data":{
      "total_time":21934,
      "score":0,
      "additional_fields":null,
      "date_first_access":"2022-04-22 10:24:19"
    }
  }
}

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

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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 Name of the session in which the user has been enrolled.
level

The enrollment level of the user.

Possible values are:

  • learner
  • tutor
  • instructor
  • coach
enrollment_date Date of the enrollment.
enrollment_date_begin_validity Start of the validity period for the enrollment (can be null).
enrollment_date_end_validity End of the validity period (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 themself.
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.

Possible values are:

  • learner
  • tutor
  • instructor
  • coach
enrollment_date Date of the enrollment.
enrollment_date_begin_validity Start of the validity period for the enrollment (can be null).
enrollment_date_end_validity End of the validity period (can be null).
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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 themself.
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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
level

User level in the course.

Possible values are:

  • learner
  • instructor
  • tutor
enrollment_date

The date when the enrollment was recorded, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
enrollment_date_begin_validity

The date when the enrollment validity starts, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
enrollment_date_end_validity

The date when the enrollment validity ends, in UTC.

Format:

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.

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.

Format:

YYYY-MM-DD HH:mm:ss
event_type

The type of the event.

Possible values are: 

  • Learn 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

The date and time of the moment the event has been fired in UTC.

Format:

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 Name of the session in which the user has been enrolled.
level

The enrollment level of the user.

Possible values are:

  • learner
  • tutor
  • instructor
  • coach
enrollment_date Date of the enrollment.
enrollment_date_begin_validity Start of the validity period for the enrollment (can be null).
enrollment_date_end_validity End of the validity period (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 themself.
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

Information: 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

Information: 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
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
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 - Break starting time for the updated session.
    • break_date_time_end - Break end time for the updated session.
    • location_name - Name of the location where the session is held.
    • location_country - Country where the session is held.
    • classrom_name - Name of the classroom where the session is 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
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
course_id ID of the course of the deleted ILT session.
course_code Code of the course of 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
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
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 new ILT session.
session_code Code of the new ILT session.
session_name Name of the new ILT session.
extra_data Extra data section.
  • session_description - Description of the new ILT session.
  • session_maximum_enrollments - Maximum number of enrollments allowed for the new ILT session.
  • session_minimum_enrollments - Minimum number of enrollments allowed for the new ILT session.
  • last_subscription_date - Last date for enrolling into the ILT session.
  • dates
    • name - Name of the new ILT session.
    • original_date - Date of the new ILT session.
    • original_timezone- Timezone set of the new session.
    • date_time_start - Starting time set for the new session.
    • date_time_end - End time set for the new session.
    • break_date_time_start - Break starting time for the new session.
    • break_date_time_end - Break end time for the new session
    • location_name - Name of the location where the session is held.
    • location_country - Country where the session is held.
    • classrom_name - Name of the classroom where the session is 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 Title of the course added to the learning plan.
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Admin created a learning plan learningplan.created

Property Description
learning_plan_id ID of the learning plan.
name Title of the learning plan.
code Code of the learning plan (it can be empty or null).
creation_date

The date of the creation, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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 Title of the learning plan.
code Code of the learning plan (it can be empty or null).
deletion_date

The date of the deletion, in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired, in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Admin updated a learning plan learningplan.updated

Property Description
learning_plan_id ID of the learning plan.
name Title of the learning plan.
code Code of the learning plan (it can be empty or null).
update_date

The date of the update in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

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

The date of the enrollment

Format:

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 themself.
enrollment_date_begin_validity The start of the validity period for the enrollment (can be null).
enrollment_date_end_validity The end of the validity period (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

The date and time of the moment the event has been fired in UTC.

Format:

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 learning plan.

Learner completed content with assigned skills skill.object.completed

Property

Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
id_user

ID of the user.
object_id

ID of the content.
object_type

Type of content.
Value:

  • course
name

Title of the content.
skills

Skills associated with the content.
  • code - ID of the skill.
  • name - name of the skill.

An assignment has been submitted lo.assignment.submission

Property Description
submission_id ID of the assignment submission created by the learner.
creation_date

The date and time when the submission was generated in UTC

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 Title of the assignment training material.
name Title for the submission, as defined by the learner.
description Comments added by the 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

The date and time of the moment the event has been fired in UTC.

Format:

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 the learner along with the submission.
creation_date

The date when the assignment was submitted in UTC

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm: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

The score given by the instructor.

The allowed range is: 0 - 100

The default value is "0".
comment The evaluation comments written by the instructor
allow_reupload

A Boolean value sets whether the learner is allowed to submit again the assignment when failed.

The default value is true.
status

The evaluation status.

Possible values are:

  • failed
  • passed
url A hashed filename of the instructor’s evaluation report.
filename The original filename, as uploaded by the instructor
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
instructor_id The ID of the instructor that evaluated this assignment.

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

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
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

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

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

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

Property Description
user_id The ID of the user who deleted the training material.
username The username of the user who deleted the training material.
course_id The ID of the course from where the training material was deleted.
course_name The title of the course  from where the training material was deleted.
training_material_name The 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

The date and time of the moment the event has been fired in UTC.

Format:

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 course where the status of the training material changed.
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

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

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

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

Training material has been updated in the Central repository tmrepo.trainingmaterial.updated

Transaction created ecommerce.transaction.created

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The transaction date and time in UTC.

Format:

yyyy-dd-mm hh:mm:ss
payment_type Payment type used to settle the transaction.
external_transaction_id Transaction ID on the payment gateway side (not always present).
payment_status

Payment status.

Possible values are:

  • successful
  • failed
  • pending
  • canceled
total_paidamount The total amount paid for the transaction.
currency Currency used to settle the transaction.

Transaction deleted ecommerce.transaction.deleted

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The transaction date and time in UTC.

Format:

yyyy-dd-mm hh:mm:ss
payment_type Payment type used to settle the transaction.
external_transaction_id Transaction ID on the payment gateway side (not always present).
payment_status Payment status, always set to canceled.
total_paidamount Total amount paid for the transaction.

Transaction updated ecommerce.transaction.updated

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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

The transaction date and time in UTC.

Format:

yyyy-dd-mm hh:mm:ss
payment_type Payment type used to settle the transaction.
external_transaction_id Transaction ID on the payment gateway side (not always present).
payment_status Payment status, always set to canceled.
total_paidamount The total amount paid for the transaction.

Registration request sent user.selfregistrationrequest.sent

Property Description
fired_at

The date and time of the moment the event has been fired in UTC.

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

The date and time of the moment the event has been fired in UTC.

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

The timestamp when the Superadmin approves the user's self-registration.

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 ID for the new user.
username Username of the new user
email Email for the newly created user (can be

nullor empty).
creation_date

The date of creation for the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
expiration_date

The date of expiration for the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
level

Level of the user created.

Possible values are:

  • superadmin
  • poweruser
  • user
firstname The first name of the user (can be null).
lastname The last name of the user (can be null).
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
provisioned

Identity Provider (IdP) with which the newly created user has been provisioned.

Possible values are:

  • 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's default language.
    • language - Field 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 Deactivated user ID.
username Username of the user.
email Email of the deactivated user (can be

nullor empty).
deactivation_date

The date of the deactivation of the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
expiration_date

The date of expiration for the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
level Level of the deactivated user.
firstname The first name of the user (can be

nullor empty).
lastname The last name of the user (can be

nullor empty).
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss
extra_data Extra data section.
  • additional_fields - Additional field language in the platform's default language.
    • language - Field 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 ID of the deleted user.
username Username of the deleted user.
deletion_date

The date of deletion of the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

User has been modified user.updated

Property Description
user_id ID of the updated user.
username Username of the updated user.
email Email of the updated user (can be

nullor empty).
update_date

The date of the update in UTC

Format:

YYYY-MM-DD HH:mm:ss
expiration_date

The date of expiration for the user in UTC

Format:

YYYY-MM-DD HH:mm:ss
level Level of the updated user.
firstname First name of the user (can be

nullor empty).
lastname Last name of the user (can be

nullor empty).
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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 (can be

nullor empty).
reactivation_date

The date when the user is reactivated in UTC.

Format:

YYYY-MM-DD HH:mm:ss
expiration_date

The date of expiration for the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
level Level of the reactivated user.
firstname First name of the reactivated user (can be

nullor empty).
lastname Last name of the reactivated user (can be

nullor empty).
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss

User registered into the platform user.selfregistered

Property Description
user_id ID of the user.
username Username of the user.
email Email of the user (can be

nullor empty).
creation_date

The date of creation for the user in UTC.

Format:

YYYY-MM-DD HH:mm:ss
level

The level of the user.

Possible values are:

  • superadmin
  • poweruser
  • user
firstname First name of the user (can be

nullor empty).
lastname Last name of the user (can be

nullor empty).
fired_at

The date and time of the moment the event has been fired in UTC.

Format:

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 course from which the additional 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

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

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

The date and time of the moment the event has been fired in UTC.

Format:

YYYY-MM-DD HH:mm:ss