Rule actions

Rule actions

Overview

The platform has a robust rules engine that allows you to customize the user experience and automate a variety of actions. Used wisely, rules can make a course more engaging and flexible. 

Examples of rules you can create include:
  1. Sending custom messages to learners when they enroll in a course. 
  2. Awarding badges to users when they complete a specific module.
  3. Enrolling learners in an intermediate level course after they complete a beginner level course. 
  4. Adding users to an "alumni" group when they complete a learning path. 
  5. Awarding certificates to learners when they complete a self-paced course.
The platform offers a variety of actions that can be added to Rules. The Rules article covers the specific events that trigger actions. This article will cover each of the available actions themselves.  

Available actions

Each action on the platform is covered below in alphabetical order. Please note the actions available in the Add action pop-up vary by triggering event. 

Add tag

The Add tag action allows you to add tags to users based on a triggering event. For example, you can use the action to add tags to learners, and then utilize Hidden and Shown filters to control the visibility of sections, modules, or assessments based on the tag(s). To add an Add tag action:  

  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Add tag.
Add action pop-up, Other tab with the Add tag button highlighted

The Add tag pop-up displays.

  1. Enter the name of a tag.
    1. Note that the name of a tag can include variables.
  2. Click + in the Filters section if you would like to further refine which users will receive the tag.
  3. Click Save.
Add tag pop-up with a tag example entered

Add to group

The Add to group action allows you to add users to a group based on a triggering event. For example, you can use the action to add learners to a group when they enroll in a course or have completed a course. To add the Add to group action:

  1. Click + Add action in a triggering event section.
  2. Click the Membership tab.
  3. Click Add to group.
Add action pop-up, Membership tab with the Add to group button highlighted

The Add to group pop-up displays.

  1. Click + Select in the Group section.
    1. A pop-up displays a list of groups. Select a group and click Submit.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners when they are added to the group. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users they have been added to the group.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be added to the group.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.


Add to-do item

The Add to-do item action allows you to add to-do items to users' to-do widgets based on triggering events.  For example, you can add a "Review the course study guide" to-do item to users' To-do widgets if they do not pass a quiz.

To add an Add to-do item action:

  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Add to-do item.
Add action, Other tab with the Add to-do item button highlighted

The Add to-do item pop-up displays.

  1. Type in the to-do Item you want added to the user's to-do list.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners when the to-do item is added. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users of the to-do item.
  3. Filters: Click + in the Filters section if you would like to further refine which users will receive a to-do item.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Add to-do item pop-up with an example Item added

Archive

The Archive action allows you to archive users based on triggering events.  For example, you can archive a user's account based on 60 days of inactivity. 
Info
Please note that an archived user can no longer log in but all their data is preserved and accessible for archival purposes.

To add an Archive action:

  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Archive.
Add action pop-up, Other tab with the Archive button highlighted

The Archive pop-up displays.

  1. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners when they are archived. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users of their account being archived.
  2. Filters: Click + in the Filters section if you would like to further refine which users the archive action will apply to.
Archive pop-up with a Canned message selected

Archive course action

The Archive course action allows you to archive courses based on triggering events, such as a finish rule.  For example, you can set up a rule that will automatically archive a course three days after it has reached its finish date. The Archive course action is only available for Instructor and Blended courses.

To add an Archive course action:

  1. Access a course or class.
  2. Click Admin from the course navigation menu.
  3. Click Schedule from the fly-out menu.
  4. Add a Finish actions rule.
  5. Click + Add action below a Finish actions rule.
  6. Click the Other tab.
  7. Click Archive course.
Add finish action pop-up, Other tab with the Archive course button highlighted
The Archive course pop-up displays.
  1. A suggested message displays, along with a list of variables that can be added to customize the message.
  2. Send to: Select if you would like the archive course message to be sent to Instructors or Administrators.
    1. Please note the send to Administrator option is only available for administrators.
  3. Click Save.
Archive course pop-up with the Send to menu active

Award badge

The Award badge action allows you to award badges to users based on triggering events. For example, you can set up a rule that will automatically award a badge to users who complete a course or module.

To add an Award badge action:

  1. Click + Add action in a triggering event section.
  2. Click the Awards tab.
  3. Click Award badge.
Add action pop-up, Awards tab with the Award badge button highlighted
The Award badge pop-up displays.
  1. Game: If you course or site has games, you can select the game the badge will be associated with.
    1. Note - Selecting a game is optional.
  2. Badge: Select the badge you want to award. Visit the Badges article to learn more about creating badges.
  3. Type: Select the type of message the user will receive when they are awarded the badge. You can select a Dropdown message or Popup message.
  4. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users of the badge.
  5. Filters: Click + in the Filters section if you would like to further refine which users will be awarded a badge.
  6. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  7. Click Save.
Award badge pop-up with a Game and Badge selected

Award certificate

The Award certificate action allows you to award certificates to users based on triggering events. For example, you can set up a rule that will automatically award a certificate to users who obtain a specific score on an assessment.

To add an Award certificate action:

  1. Click + Add action in a triggering event section.
  2. Click the Awards tab.
  3. Click Award certificate.
Add action pop-up, Awards tab with the Award certificate button highlighted

The Award certificate pop-up displays.

  1. Certificate: Select the certificate you want to award. Visit the Certificates article to learn more about creating certificates.
  2. Type: Select the type of message the user will receive when they are awarded the certificate. You can select a Dropdown message or Popup message.
  3. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users of the certificate.
  4. Filters: Click + in the Filters section if you would like to further refine which users will be awarded a certificate.
  5. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  6. Click Save.
Award certificate pop-up with a certificate selected

Award coupon

The Award coupon action allows you to award coupons to users based on triggering events. For example, you can set up a rule that will send a learner a 50% discount to an advanced course when they complete an intermediate course.  

To add an Award coupon action:

  1. Click + Add action in a triggering event section.
  2. Click the Awards tab.
  3. Click Award coupon.
Add action pop-up, Awards tab with the Award coupon button highlighted
The Award coupon pop-up displays.
  1. Coupon: Select the coupon you would like to award.
    1. To ensure that learners cannot simply give the coupon to someone else to use when the action is triggered, learners are automatically added as a user in the coupon's scope. To learn more about coupons, visit the E-commerce topic.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
      1. Note that canned message lists all coupon items with discounts and links in the learner message. If you would like to be more specific about which courses the coupon applies to, create a Custom message.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users of the coupon.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be awarded a coupon.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Award coupon pop-up with the Coupon menu active

Award points

The Award points action allows you to award points to users based on triggering events. Users can collect the points to advance through levels of a game, and to move up in rankings on a leaderboard. For example, you can set up a rule that awards users 20 points for every module users complete, as well as 50 points for posting to a forum.  

To add an Award points action:

  1. Click + Add action in a triggering event section.
  2. Click the Awards tab.
  3. Click Award points.
Add action pop-up, Awards tab with the Award points button highlighted

The Award points pop-up displays.

  1. Game: Select the game you want the points to apply to. To learn more about games, visit the Course games article. 
  2. Points: Enter the number of points you want to award the user for completing the triggering event.
  3. Type: Select the type of message the user will receive when they are awarded the points. You can select a Dropdown message or Popup message.
  4. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users of the awarded points.
  5. Filters: Click + in the Filters section if you would like to further refine which users will be awarded points.
  6. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  7. Click Save.
Award points pop-up with a Game selected and an example of 25 points entered

Deactivate learner or student

The Deactivate action allows you to deactivate a learner in a course based on triggering events. For example, you can set up a rule that deactivates a student from a course seven days after they complete it. To add a Deactivate action:
  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Deactivate.
Add action pop-up, Other tab with the Deactivate button highlighted

The Deactivate pop-up displays.

  1. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when they are deactivated.
  2. When: You can select if you would like to deactivate the learner immediately, at a specified time, or after a specified time.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be deactivated.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Deactivate pop-up with a canned message selected and Immediately selected in the When drop-down

Enroll in course

The Enroll in course action allows you to automatically enroll a learner in a course based on triggering events. For example, you can set up a rule that enrolls a learner in an advanced course after they completed a basic course. To add an Enroll in course action:
  1. Click + Add action in a triggering event section.
  2. Click the Membership tab.
  3. Click Enroll in course.
Add action pop-up, Membership tab with the Enroll in course button highlighted

The Enroll in course pop-up displays.

  1. Course: Click Select to choose a course. 
    1. A pop-up will open with a list of courses. Select a course, then click Submit. 
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when they are enrolled in the course.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be enrolled in the course.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.


Hide assessment

Info
Note - Adaptive learning must be installed on your platform to use the Hide assessment action. 

The Hide assessment action allows you to hide assessments from specific learners based on triggering events. For example, you can hide assessments from learners who have completed an equivalent assessment. To add a Hide assessment action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Hide assessment.
Info
Please note the business platform uses the term assessment, and the academia platform uses the term assignment. The terms assessment and assignment are interchangeable in this article. 

Add action pop-up, Access tab with the Hide assessment button highlighted

The Hide assessment pop-up displays.
  1. Assessment: Select the assessment you want to hide.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when an assessment is hidden.
  3. Filters: Click + in the Filters section if you would like to further refine which users will not see the assessment.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.

Hide module

Info
Note - Adaptive learning must be installed on your platform to use the Hide module action.

The Hide module action allows you to hide modules from specific learners based on triggering events. For example, you can hide modules from learners who have already completed it. To add a Hide module action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Hide module.
Info
Info
Please note the business platform uses the term module, and the academia platform uses the term lesson. The terms module and lesson are interchangeable in this article. 

Add action pop-up, Access tab with the Hide module button highlighted

The Hide module pop-up displays.
  1. Module: Select the module you want to hide.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when a module is hidden.
  3. Filters: Click + in the Filters section if you would like to further refine which users will not see the module.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Hide module pop-up with a Module selected and a Canned message

Hide section

Info
Note - Adaptive learning must be installed on your platform to use the Hide section action.

The Hide section action allows you to hide sections from specific learners based on triggering events. For example, you can hide sections from learners who have already completed it. To add a Hide section action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Hide section.
Add action pop-up, Access tab with the Hide section button highlighted

The Hide section pop-up displays.

  1. Section: Select the section you want to hide.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when a section is hidden.
  3. Filters: Click + in the Filters section if you would like to further refine which users will not see the section.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Hide section pop-up with a Section selected and a Canned message

Lock/Unlock course 

The Lock course and Unlock course actions allows you to lock and unlock courses at a time before, on, or after a course starts or finishes. For example, you can unlock courses a day before they begin, and lock courses the day after they end. The Lock course and Unlock course actions are only available for Instructor and Blended courses.

To add a Lock course or Unlock course action:
  1. Access a course or class.
  2. Click Admin from the course navigation menu.
  3. Click Schedule from the fly-out menu.
  4. Add a Start actions rule or Finish actions rule.
  5. Click + Add action in the start or finish rule.
  6. Click Lock course or Unlock course in the Access tab.

Add action pop-up for a start action or finish action, Access tab

The Lock course or Unlock course pop-up displays.
  1. A suggested message displays, along with a list of variables that can be added to customize the message.
  2. Send to: Select if you would like the course lock/unlock message to be sent to Instructors or Administrators.
    1. Please note the send to Administrator option is only available for administrators.
  3. Click Save.
Unlock courses pop-up with a sample message and the Send to menu active

A locked course can appear in the catalog and allow enrollment, but learners cannot enter the course until it's unlocked.

If a learner is enrolled in a locked course, its locked status is displayed in the dashboard tile
Locked course tile example

Lock module

The Lock module action allows you to lock modules at a specific time based on triggering events. For example, you can lock a module a week after a learner enrolls in a course. To add a Lock module action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Lock module.
Add action pop-up, Access tab with the Lock module button highlighted

The Lock module pop-up displays.

  1. Module: Select the module you want to lock.
  2. When: You can choose to lock the module immediately, at a specific time, or after a specified amount of time.
  3. Click Save.

Remove from group

The Remove from group action allows you to remove users from a group based on a triggering event. For example, you can use the action to remove learners from a group after they pass a specific exam. To add a Remove from group action:

  1. Click + Add action in a triggering event section.
  2. Click the Membership tab.
  3. Click Remove from group.
Add action pop-up, Membership tab with the Remove from group button highlighted

The Remove from group pop-up displays.

  1. Group: Click + Select in the Group section.
    1. A pop-up will open with a list of groups. Select the group, then click Submit.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners when they are removed from the group. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users they have been removed from the group.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be removed from the group.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.

Remove tag

The Remove tag action allows you to remove tags from users based on a triggering event. For example, you can use the action to remove tags from learners, and then utilize Hidden and Shown filters to control the visibility of sections, modules, or assessments based on the tag(s). To add a Remove tag action:  

  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Remove tag.

The Remove tag pop-up displays.

  1. Enter the name of a tag.
    1. Note that the name of a tag can include variables.
  2. Filters: Click + in the Filters section if you would like to further refine which users will have the tag removed.
  3. Click Save.
Remove tag pop-up with a tag example entered

Send canned message

The Send canned message action allows you to send canned messages to users based on a triggering event. Many events already include canned messages, such as course enrollment and completion. To add a new Send canned message action:  

  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Send the canned message: "example".

The Send the canned message: "event" pop-up displays.

  1. Type: Select the type of canned message the user will receive. You can select a Dropdown message or Popup message.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
      1. The @course_name, @badge_name, etc. variables are substituted automatically by the site. The @why variable inserts the reason that the action occurred, such as "This happened because: you completed module one."
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
      1. If you have added custom account fields to your platform, then the values of these fields are available as variables in rule actions. For example, the account field "Custom field " would be available as the variable @user_custom_field. (@user_ + the name of the field in lowercase with spaces replaced with underscores). For more details on how to add custom account fields, please visit the Accounts topic. 
  3. Filters: Click + in the Filters section if you would like to further refine which users will be removed from the group.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.

Send custom notification

The Send custom notification action allows you to send custom notifications to users based on a triggering event. For example, you can send users a custom notification two days before a class starts. To add a Send custom notification action:  

  1. Click + Add action in a triggering event section.
  2. Click the Other tab.
  3. Click Send custom notification.
Add action pop-up, Other tab with the Send custom notification button highlighted

The Send custom notification pop-up displays.

  1. Type: Select the type of message the user will receive. You can select a Dropdown message or Popup message.
  2. Enter a subject and content for the message. A list of variables that can be used is included at the top of the pop-up.
    1. If you have added custom account fields to your platform, then the values of these fields are available as variables in rule actions. For example, the account field "Custom field " would be available as the variable @user_custom_field. (@user_ + the name of the field in lowercase with spaces replaced with underscores). For more details on how to add custom account fields, please visit the Accounts topic. 
    2. Please note that variables with links are not supported in the subject of notifications. Variables with links are only supported in the body of notifications.
  3. Send to: Select if you would like the custom notification to Learners, Instructors, Administrators, Billing contacts, Managers, or a specific user.
  4. When: Select if you would like to send the custom notification immediately when the trigger event occurs, at a specified time, or after a specified time.
  5. Filters: Click + in the Filters section if you would like to further refine which users will be sent the notification.
  6. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  7. Click Save.
Send custom notification pop-up with Instructors selected in the Send to drop down

Show assessment

Info
Note - Adaptive learning must be installed on your platform to use the Show assessment action.
The Show assessment action allows you to show assessments that are hidden by default to specific learners based on triggering events. For example, you can create an assessment that is only shown to learners who have completed a specific module. To add a Show assessment action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Show assessment.
Add action pop-up, Access tab with the Show assessment button highlighted

The Show assessment pop-up displays.

  1. Assessment: Select the assessment you want to show.
    1. Note, this feature works best if the assessment visibility default is set to Hidden.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when an assessment becomes visible.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be shown the assessment.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Show assessment pop-up with an assessment selected and a canned message

Show module

Info
Note - Adaptive learning must be installed on your platform to use the Show module action.
The Show module action allows you to show modules that are hidden by default to specific learners based on triggering events. For example, you can show a module to learners only after they have passed a previous assessment.  To add a Show module action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Show module.
Add action pop-up, Access tab with the Show module button highlighted

The Show module pop-up displays.

  1. Module: Select the module you want to show.
    1. Note, this feature works best if the module visibility default is set to Hidden.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when a module becomes visible.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be shown the module.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Show module pop-up with a module selected and a canned message

Show section

Info
Note - Adaptive learning must be installed on your platform to use the Show section action.
The Show section action allows you to show sections that are hidden by default to specific learners based on triggering events. For example, you can show a section to learners only after they have completed a previous section.  To add a Show section action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Show section.
Add action pop-up, Access tab with the Show section button highlighted

The Show section pop-up displays.

  1. Section: Select the section you want to show.
    1. Note, this feature works best if the section visibility default is set to Hidden.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when a section becomes visible.
  3. Filters: Click + in the Filters section if you would like to further refine which users will be shown the section.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Show section pop-up with a section selected and a canned message

Unlock module

The Unlock module action allows you to unlock modules for learners at a specific time based on triggering events. For example, you can unlock a module after a learner completes an assessment. To add an Unlock module action:
  1. Click + Add action in a triggering event section.
  2. Click the Access tab.
  3. Click Unlock module.

Add action pop-up, Access tab with the Unlock module button highlighted

The Unlock module pop-up displays.

  1. Module: Select the module you want to unlock.
  2. Select the type of message you want to send.
    1. Canned: If you select Canned, a canned message is sent to learners when the module is unlocked. A preview of the message and its variables is displayed.
    2. Custom: If you select Custom, you can create your own message. A suggested message displays, along with a list of variables that can be added.
    3. None: Select None if you do not want to notify users when a module is unlocked.
  3. When: Select if you would like to unlock the module immediately when the trigger event occurs, at a specified time, or after a specified time.
  4. Apply retroactively?: Check the Apply retroactively? checkbox if you would like the action to apply retroactively to users that have already triggered the event.
  5. Click Save.
Add action pop-up, Access tab with the Unlock module button highlighted


Webhook

Info
To use Webhook actions, an administrator must first install the Webhooks app from the App center. 
The Webhook action allows you to call a third-party API based on triggering events. For example, you can have the platform call an API after a learner completes a course. To add a Webhook action:
  1. Click + Add action in a triggering event section.
  2. Click the Integrations tab.
  3. Click Webhook.
Add action pop-up, Integrations pop-up with the Webhook button highlighted

The Webhook pop-up displays.

  1. Enter an API Endpoint.
  2. Enter the API Parameters.
  3. Filters: Click + in the Filters section if you would like to further refine which users the API call would apply to. 
  4. Click Save.
Webhook pop-up

xAPI

Info
To use xAPI actions, an administrator must first install the xAPI app from the App center.
The xAPI action allows you to invoke xAPI statements based on triggering events. For example, you can invoke an xAPI statement after an account is created, or when a learner finishes a course.  To add an xAPI action:
  1. Click + Add action in a triggering event section.
  2. Click the Integrations tab.
  3. Click xAPI.

Add action pop-up, Integrations pop-up with the xAPI button highlighted

The xAPI pop-up displays.
  1. Select an xAPI Server.
    1. The server must be set up by an administrator.
  2. Select an xAPI Actor.
  3. Select an xAPI Verb.
  4. Select an xAPI Object.
  5. Filters: Click + in the Filters section if you would like to further refine which users the xAPI statement would apply to. 
  6. Click Save.

xAPI pop-up with an LRS server selected, Learner selected as the xAPI Actor, and Attempted selected as the xAPI Verb