LearnWorlds Help Center

https://support.learnworlds.com/support/home
Admin
The LearnWorlds Help Center provides comprehensive support and guides for building, managing, and...
Tokens:87,507
Snippets:428
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### LearnWorlds OpenID Connect SSO Integration Guides

Source: https://support.learnworlds.com/support/home/solutions/articles/12000100248-how-to-use-google-with-learnworlds-openid-connect-sso

Provides links to setup guides for integrating various identity providers with LearnWorlds using OpenID Connect (OIDC) for Single Sign-On. These guides explain the necessary steps for configuring LearnWorlds and the external identity provider for user authentication.

```APIDOC
OpenID Connect (OIDC) SSO Integration:

Purpose: Enable Single Sign-On using the OpenID Connect (OIDC) protocol to authenticate users with external identity providers.

Related Providers & Guides:
- General OIDC Setup: How to Set up SSO for your Users with almost any Identity Provider (OpenID Connect)
- Facebook: How to Use Facebook with LearnWorlds OpenID Connect SSO
- LinkedIn: How to Use LinkedIn with LearnWorlds OpenID Connect SSO
- Okta: How to Use Okta with Learnworlds OpenID Connect SSO
- GitLab: How to Use GitLab with Learnworlds OpenID Connect SSO
- Auth0: How to Use Auth0 with Learnworlds OpenID Connect SSO
- Microsoft Entra: How to Use Microsoft Entra with Learnworlds OpenID Connect SSO
- Xero: How to Use Xero with Learnworlds OpenID Connect SSO
- Salesforce: How to Use Salesforce with Learnworlds OpenID Connect SSO

Note: Specific configuration details, parameters, and return values depend on the chosen identity provider and are detailed in the respective linked guides.
```

--------------------------------

### LearnWorlds SAML SSO Integration Guides

Source: https://support.learnworlds.com/support/home/solutions/articles/12000100248-how-to-use-google-with-learnworlds-openid-connect-sso

Provides links to setup guides for integrating various identity providers with LearnWorlds using SAML for Single Sign-On. These guides detail the steps required to configure both LearnWorlds and the external identity provider for seamless user authentication.

```APIDOC
SAML SSO Integration:

Purpose: Enable Single Sign-On using the Security Assertion Markup Language (SAML) protocol to authenticate users with external identity providers.

Related Providers & Guides:
- General SAML Setup: How to Set up SSO for your Users with almost any Identity Provider (using SAML)
- Azure AD: How to Use Azure AD with Learnworlds SAML SSO
- Auth0: How to Use Auth0 with Learnworlds SAML SSO
- Okta: How to Use Okta with Learnworlds SAML SSO
- OneLogin: How to Use OneLogin with Learnworlds SAML SSO
- Salesforce: How to Use Salesforce with Learnworlds SAML SSO

Note: Specific configuration details, parameters, and return values depend on the chosen identity provider and are detailed in the respective linked guides.
```

--------------------------------

### Salesforce Identity Provider Setup

Source: https://support.learnworlds.com/support/home/solutions/articles/12000100352-how-to-use-salesforce-with-learnworlds-saml-sso

Steps to enable Salesforce as an Identity Provider. This involves navigating through Salesforce setup menus and activating the Identity Provider functionality.

```APIDOC
Salesforce Identity Provider Enablement:
  Action: Enable Identity Provider
  Steps:
    1. Log in to Salesforce as an Administrator.
    2. Navigate to the Cog icon -> Open Advanced setup.
    3. In the Quick Find box, type 'Identity Provider' and select the option.
    4. Click 'Enable Identity Provider'.
    5. Select a certificate from the drop-down menu or create a new one.
```

--------------------------------

### Zapier Integration Navigation and Setup

Source: https://support.learnworlds.com/support/home/solutions/articles/12000040396-how-to-use-zapier-to-connect-your-learnworlds-school-with-6000-apps

Describes the steps to access and initiate Zapier integration setup within the LearnWorlds admin panel. This involves navigating to specific settings and using provided Zap templates to create new automations.

```APIDOC
Navigation:
  Settings -> Integrations -> Zapier

Action:
  Click 'Use this Zap' to connect to Zapier Account and create a new Zap.

Purpose:
  Access pre-built Zap templates and initiate the connection process with Zapier for automating workflows between LearnWorlds and other applications.
```

--------------------------------

### Zapier Integration Navigation and Setup

Source: https://support.learnworlds.com/support/home/solutions/articles/12000040396-how-to-use-zapier-to-connect-your-learnworlds-school-with-4000-apps

Describes the steps to access and initiate Zapier integration setup within the LearnWorlds admin panel. This involves navigating to specific settings and using provided Zap templates to create new automations.

```APIDOC
Navigation:
  Settings -> Integrations -> Zapier

Action:
  Click 'Use this Zap' to connect to Zapier Account and create a new Zap.

Purpose:
  Access pre-built Zap templates and initiate the connection process with Zapier for automating workflows between LearnWorlds and other applications.
```

--------------------------------

### accessiBe Integration and Features

Source: https://support.learnworlds.com/support/home/solutions/articles/12000086621-how-to-enhance-the-accessibility-of-your-school-with-accessibe

Details the integration process for accessiBe with LearnWorlds, outlining available accessibility features and limitations. This includes steps for account creation, website setup, and obtaining the installation code.

```APIDOC
accessiBe Integration Guide:

**Purpose**: To enhance the accessibility of a LearnWorlds school by integrating the accessiBe web accessibility solution.

**Features Provided by accessiBe**: 
- Seizure Safe profile
- Keyboard Navigation Adjustments
- Blind Users (Screen Reader) support
- Content Adjustments (Scaling, Highlighting, Font Size/Spacing)
- Color Adjustments (Dark/Light/High Contrast)
- Orientation Adjustments (Mute sound, Big Cursors, Stop Animations)
- ADHD Friendly Profile

**Limitations**: The accessiBe tool cannot modify the following aspects of your school's content:
- External Files (PDFs, etc.)
- Embedded Content (Videos, Presentations)
- Interactive Content (SCORM, HTML5 packages)
- Third-Party Integrations (LTI)
- Media with complex effects (flashing images, complex animations)

**Integration Steps**: 
1.  **Create/Sign in to accessiBe Account**: Visit the accessiBe website and create an account or log in.
2.  **Add New Websites**: Navigate to 'My Licenses' in the accessiBe dashboard and select '+Add New Websites'.
3.  **Configure Website**: Enter the URL of your LearnWorlds school and configure the necessary settings.
4.  **Obtain Installation Code**: Copy the generated accessiBe installation code from the 'Installation Tab' or via the 'Copy to Clipboard' button.

**Parameters for Website Configuration**: 
- `website_url`: The URL of the LearnWorlds school (e.g., `https://your-school-name.learnworlds.com`).

**Return Value**: The accessiBe installation code snippet to be added to the LearnWorlds school.

**Related Functionality**: User experience examples for ADHD Friendly Profile and Color/Content Adjustments are available via visual aids (GIFs) in the documentation.
```

--------------------------------

### Bluehost CNAME Setup Instructions

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080111-how-to-set-up-your-custom-domain-cname-record-in-popular-domain-providers

Guides users to external documentation for setting up CNAME records in Bluehost, as the process involves specific UI steps.

```APIDOC
Bluehost CNAME Setup:
Follow the steps shown in this article: https://www.bluehost.com/help/article/dns-management-add-edit-or-delete-dns-entries
```

--------------------------------

### Initial Sync and Real-time Updates

Source: https://support.learnworlds.com/support/home/solutions/articles/12000091006-how-to-integrate-moosend-with-your-learnworlds-school

Information regarding the initial synchronization process after connecting Moosend and LearnWorlds, and how contact data is updated in real-time.

```APIDOC
Initial Connection Steps:
1. Select your Moosend lists for users and leads.
2. Choose autograding options if applicable.
3. Save your settings.
4. Sync your contacts.

Real-time Synchronization:
- Users and data changes are synchronized automatically in real-time.
- Adding users via Excel in LearnWorlds creates new contacts in Moosend with relevant fields and tags.

Limitations:
- Updating users via Excel in LearnWorlds does not update fields or add tags in Moosend.
- User tags present before the first sync are not synced to Moosend.
```

--------------------------------

### Zapier Integration Example: New Product Purchase to Email Invoice

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080668-how-to-create-a-zap-zap-example-

This snippet outlines a common automation workflow using Zapier. It details the trigger event (new product bought) and the subsequent action (accountant receives email with invoice details). This demonstrates how to connect LearnWorlds events with external services for automated business processes.

```APIDOC
Zapier Automation Workflow:

  Trigger:
    Event: New Product Bought
    Description: Initiated when a customer successfully purchases a new product within the LearnWorlds school.
    Source: LearnWorlds

  Action:
    Event: Send Email
    Description: An email containing invoice details is sent to the designated accountant.
    Recipient: Accountant
    Content: Invoice Details
    Service: Email Service (e.g., Gmail, Outlook)

  Integration Platform: Zapier

  Related Concepts:
    - Connecting Zapier with LearnWorlds: For detailed setup instructions on linking your LearnWorlds account to Zapier.
    - Zapier Triggers and Actions: Understanding the core components of Zapier automation.
```

--------------------------------

### LearnWorlds SAML Setup Steps

Source: https://support.learnworlds.com/support/home/solutions/articles/12000075025-how-to-use-auth0-with-learnworlds-saml-sso

Steps to configure SAML authentication within your LearnWorlds school settings, including activating the feature and inputting necessary details.

```configuration
1. Navigate to Website -> Website settings -> Authentication in your LearnWorlds school.
2. Select the 'SAML' option.
3. Click 'Add' to create a new SAML configuration.
4. Activate SAML and provide a descriptive name for this SAML solution.
5. Input the required information from your Identity Provider (Auth0):
   - IDP Identifier (Entity ID)
   - Sign-on URL
   - Single Logout URL (optional)
   - Identity Provider Certificate (paste the content of the downloaded certificate file).
6. Ensure the Service Provider (SP) URL and Assertion Consumer Service (ACS) URL from your LearnWorlds school are correctly configured in your Auth0 application's callback URLs.
```

--------------------------------

### AI Guided Dialogue Question Configuration

Source: https://support.learnworlds.com/support/home/solutions/articles/12000104454-how-to-create-ai-dialogue-questions-with-response-based-follow-ups

Configure the core settings for an AI-Guided Dialogue question, including its visibility, requirement status, and AI prompt guidance.

```APIDOC
AIGuidedDialogueQuestion:
  __init__(question_text: str, is_required: bool = True, hide_from_learners: bool = False)
    question_text: The main open-ended question presented to the learner.
    is_required: Determines if the learner must answer this question (default: true).
    hide_from_learners: If true, the question is not displayed to learners (default: false).

  configure_ai_guidance(prompt_directions: list[str], number_of_questions: int = 1, tone_of_voice: str = 'Engaging', allow_answer_editing: bool = True)
    prompt_directions: A list of strings guiding the AI on the focus of follow-up questions (e.g., 'Examples', 'Personal experiences', 'Reasons').
    number_of_questions: The quantity of follow-up questions the AI should generate (default: 1).
    tone_of_voice: The AI's persona for generating follow-up prompts. Options include 'Friendly', 'Formal', 'Playful', 'Empowering', 'Inspirational', 'Professional', 'Urgent', 'Engaging', and more (default: 'Engaging').
    allow_answer_editing: If true, learners can revise their initial answer after responding to follow-ups (default: true).
```

--------------------------------

### Wistia Video Embed Code with Example ID

Source: https://support.learnworlds.com/support/home/solutions/articles/12000005188-how-to-embed-your-learnworlds-uploaded-videos-in-ebooks-legacy-

An example demonstrating the Wistia video embed code with a specific video ID ('9afdaytzzz') replacing the **VIDEO_ID** placeholder. This illustrates how the actual video ID is integrated into the iframe source URL.

```html
<div class="wistia_responsive_padding" style="padding:75% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><iframe src="https://fast.wistia.net/embed/iframe/**9afdaytzzz**?seo=false&videoFoam=true&playerColor=49326B" title=" Parts Perspective | 6A | Deflating &amp; Placing.mp4 Video" allowtransparency="true" frameborder="0" scrolling="no" class="wistia_embed" name="wistia_embed" allowfullscreen mozallowfullscreen webkitallowfullscreen oallowfullscreen msallowfullscreen width="100%" height="100%"></iframe></div></div><script src="https://fast.wistia.net/assets/external/E-v1.js" async></script>
```

--------------------------------

### Custom URL Parameter Handling (JavaScript/Liquid)

Source: https://support.learnworlds.com/support/home/solutions/articles/12000082906-custom-code-case-examples

Checks for a specific URL parameter ('example') and displays an alert if it matches. This allows website behavior to be modified based on URL query strings.

```Liquid
<script type="text/javascript">
    // Add custom url params to your external links
    // and handle referred users differently
        {% if REQUEST.PARAMS.example == 'example'  %}
            alert("Welcome!")
        {% endif %}
</script>
```

--------------------------------

### Squarespace CNAME Setup Instructions

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080111-how-to-set-up-your-custom-domain-cname-record-in-popular-domain-providers

Provides a link to Squarespace's support documentation for guidance on pointing a domain to a URL using CNAME records.

```APIDOC
Squarespace CNAME Setup:
Follow the steps shown in this article: https://support.squarespace.com/hc/en-us/articles/215744668#toc-point-to-a-url
```

--------------------------------

### 1AND1 CNAME Record Setup

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080111-how-to-set-up-your-custom-domain-cname-record-in-popular-domain-providers

Details the process for setting up a CNAME record in 1AND1 (IONOS) to connect your custom subdomain to your LearnWorlds school.

```APIDOC
1AND1 CNAME Setup:
1. Log in to your account at https://admin.1and1.com.
2. Click on Domains→Domain Center.
3. Click on Domain Name.
4. Click on Subdomain Overview.
5. Go to New to create the subdomain. Enter your subdomain (e.g., www).
6. Click OK.
7. Select the checkbox next to the subdomain.
8. From the DNS menu, select Edit DNS Settings.
9. Select CNAME.
10. In Alias, enter cname.learnworlds.com. Click on I read and Agree and hit Save.
```

--------------------------------

### Request Domain Change in LearnWorlds

Source: https://support.learnworlds.com/support/home/solutions/articles/12000002991-how-to-set-up-your-custom-domain-cname-record-

Procedure to inform LearnWorlds about your custom domain setup after DNS records are correctly configured. This involves navigating to school settings and adding the domain.

```APIDOC
LearnWorlds Domain Request:

Navigation:
  1. Go to Settings -> School Settings -> Site & Email Domain.
  2. Click 'Add Domain'.
  3. Enter the configured subdomain (e.g., www.myschool.com).
  4. Click 'Save'.

Confirmation:
  - A message will indicate the domain will be ready within 5 minutes.
  - Once ready, use the custom domain exclusively.
  - The CNAME record must remain active.
  - Option to 'Set primary' for multiple custom domains.
```

--------------------------------

### Google Tag Manager Server Container Setup

Source: https://support.learnworlds.com/support/home/solutions/articles/12000100878-how-to-use-automations-combined-with-google-tag-manager

Steps to create a Google Tag Manager container specifically for server-side tagging. This includes creating the container, selecting the 'Server' type, and automatically provisioning the tagging server.

```APIDOC
Google Tag Manager Container Creation:
  1. Go to: https://tagmanager.google.com/#/home
  2. Create Container:
     - Container name: [Descriptive name for your container]
     - Account: [Your Google Account]
     - Type: Server
     - Click: Create
  3. Provision Tagging Server:
     - Choose: "Automatically provision tagging server"
     - Select: Your billing account
  4. Copy Default URL: After provisioning, copy the provided default URL for your tagging server.
```

--------------------------------

### Request Domain Change in LearnWorlds

Source: https://support.learnworlds.com/support/home/solutions/articles/12000002991-how-can-i-use-my-own-domain-name-with-my-learnworlds-online-school-

Procedure to inform LearnWorlds about your custom domain setup after DNS records are correctly configured. This involves navigating to school settings and adding the domain.

```APIDOC
LearnWorlds Domain Request:

Navigation:
  1. Go to Settings -> School Settings -> Site & Email Domain.
  2. Click 'Add Domain'.
  3. Enter the configured subdomain (e.g., www.myschool.com).
  4. Click 'Save'.

Confirmation:
  - A message will indicate the domain will be ready within 5 minutes.
  - Once ready, use the custom domain exclusively.
  - The CNAME record must remain active.
  - Option to 'Set primary' for multiple custom domains.
```

--------------------------------

### LearnWorlds WordPress SSO Plugin

Source: https://support.learnworlds.com/support/home/solutions/articles/12000100248-how-to-use-google-with-learnworlds-openid-connect-sso

Describes the integration method for connecting a WordPress site with LearnWorlds using a dedicated WP SSO plugin. This enables Single Sign-On functionality between the two platforms.

```APIDOC
WordPress SSO Plugin Integration:

Purpose: Connect a WordPress site with LearnWorlds to enable Single Sign-On (SSO) functionality.

Method: Utilize the LearnWorlds WP SSO plugin for integration.

Reference: How to Connect your WordPress Site with LearnWorlds with our WP SSO plugin

Note: Specific plugin configuration details and requirements are available in the linked guide.
```

--------------------------------

### Google OpenID Connect Discovery Document

Source: https://support.learnworlds.com/support/home/solutions/articles/12000100248-how-to-use-google-with-learnworlds-openid-connect-sso

This is the standard OpenID Connect discovery endpoint for Google. It provides metadata about the OpenID Provider, including its endpoints, supported response types, subject types, and claims.

```APIDOC
Endpoint:
  https://accounts.google.com/.well-known/openid-configuration

Description:
  Provides configuration information for Google's OpenID Connect provider. This includes details about authorization endpoints, token endpoints, userinfo endpoints, JWKS URIs, and supported scopes and claims.

Usage:
  This URL is typically fetched by an OpenID Connect relying party (like LearnWorlds) to dynamically configure its interactions with the OpenID Provider (Google).

Key Information Provided:
  - authorization_endpoint: URL for the authorization server's authorization endpoint.
  - token_endpoint: URL for the authorization server's token endpoint.
  - userinfo_endpoint: URL for the UserInfo endpoint.
  - jwks_uri: URL of the authorization server's JWK Set.
  - issuer: The issuer identifier for the authorization server.
  - supported_scopes: List of scopes the authorization server supports.
  - claims_supported: List of claims that the userinfo endpoint can return.
  - response_types_supported: List of response types supported by the authorization endpoint.
  - subject_types_supported: List of subject types supported by the authorization server.
  - id_token_signing_alg_values_supported: List of signing algorithms supported for ID Tokens.

Related Concepts:
  - OAuth 2.0
  - OpenID Connect Core 1.0
  - Client ID and Client Secret (obtained from Google Cloud Console)
  - Redirect URL (configured in Google Cloud Console and LearnWorlds)
```

--------------------------------

### LearnWorlds Actions: Products

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Actions to manage user enrollment and access to products within the LearnWorlds platform.

```APIDOC
Actions - Products:
  Enroll in Products
    Description: Grants the user access to a product.

  Un-Enroll from Products
    Description: Removes user access from a product.
```

--------------------------------

### Manually Add Table of Contents

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080218-how-to-add-table-of-contents-to-your-videos

Guides users through adding chapters manually in the video editor. Requires setting titles and start times for each chapter to define navigation points.

```APIDOC
VideoEditor.Contents.addChapter(title: string, startTime: { hours: integer, minutes: integer, seconds: integer })
  - Adds a new navigation point (chapter) to the video's table of contents.
  - Parameters:
    - title: The display name for the chapter.
    - startTime: The specific timestamp within the video where the chapter begins.
      - hours: The hour component of the start time.
      - minutes: The minute component of the start time.
      - seconds: The second component of the start time.
  - Action: Saves the new chapter entry.

VideoEditor.Contents.configureChapterDisplay(markersOnProgressBar: boolean, markersWhenHidden: boolean)
  - Configures how chapter markers are displayed on the video progress bar.
  - Parameters:
    - markersOnProgressBar: If true, chapter markers are visible on the progress bar.
    - markersWhenHidden: If true, chapter markers are visible even when the progress bar is hidden.
  - Action: Applies the chosen display settings for chapters.
```

--------------------------------

### Installments API

Source: https://support.learnworlds.com/support/home/solutions/articles/12000017230-learnworlds-api-documentation

Endpoint for retrieving a list of active user installments.

```APIDOC
Installments API:

Get active installments:
  GET https://api.learnworlds.com/v2/installments/active
  Description: Returns a list of active installments of users.
```

--------------------------------

### Automations Page Actions and Information

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Details the functionalities available on the Automations page, including searching, viewing automation status, execution history, and performing management actions.

```APIDOC
Automations Page Overview:

Features:
- Search Bar: Allows users to find created automations by name or keyword.
- Automation List: Displays all created automations.
- Execution Count: Shows the number of times an automation has been executed.
- Last Edited Date: Indicates when an automation was last modified.
- Status: Displays whether an automation is Active or Inactive.

Actions:
- Preview: View the Triggers, Actions, and Conditions of a specific automation workflow.
- Edit: Modify an existing automation.
- Duplicate: Create a copy of an existing automation.
- Delete: Remove an automation.

Execution Details:
- Clicking the 'No. of times executed' displays a detailed list of all automation events and their occurrences.
```

--------------------------------

### Installment Plan Payment Links

Source: https://support.learnworlds.com/support/home/solutions/articles/12000081471-how-to-use-direct-payment-links-in-learnworlds-with-coupons-custom-pages-

Generates a specific payment link for products configured with installment payment plans. This link directs users directly to the checkout page with the installment option pre-selected, streamlining the purchase process for payment plans.

```APIDOC
Installment Payment Link:
  [Obtained via 'Get URL' on the Pricing tab for the installment plan]

Purpose:
  To provide a direct link to the payment page where a specific installment plan is already selected for a product.

Usage:
  Share this URL directly with customers who should use the installment payment option.
  The link leads to the checkout with the installment plan pre-selected, simplifying the user experience.
```

--------------------------------

### LearnWorlds Actions: Webhooks

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Action to send data via webhooks to external services.

```APIDOC
Actions - Webhooks:
  Send a webhook
    Description: Sends webhook data to a configured URL.
```

--------------------------------

### LearnWorlds Actions: User Progress

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Actions to update the completion status of courses and learning activities for users.

```APIDOC
Actions - User Progress:
  Set Course as Completed
    Description: Marks a course as completed for the user.

  Set Learning Activity as Completed
    Description: Marks specific learning activities as completed for the user.

  Reset course progress
    Description: Resets a user's progress in a specific course.

  Reset learning activity progress
    Description: Resets a user's progress in a specific learning activity.
```

--------------------------------

### Example UTM-Enhanced URL

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080163-how-to-use-utms-urchin-tracking-module-

An example of a URL used to track user attribution, including standard UTM parameters for campaign tracking. These parameters are extracted from the URL when a visitor clicks the link.

```URL
https://myschool.learnworlds.com/course/free-course?utm_medium=banner&utm_source=facebook&utm_campaign=buffer
```

--------------------------------

### LearnWorlds User Automations Overview

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

User Automations in LearnWorlds enable the automation of common tasks within your school. They operate based on a sequence of Triggers, optional Conditions, and defined Actions to streamline user management and engagement without manual intervention.

```APIDOC
UserAutomations:
  Purpose: Automate common tasks in a LearnWorlds school.
  Components:
    - Triggers: Events that initiate an automation (e.g., user activity).
    - Conditions: Optional filters to refine when an automation runs.
    - Actions: Tasks performed by the automation (e.g., enroll user, send email, manage groups).
  Availability:
    - Starter: Not available
    - Pro Trainer: Available
    - Learning Center: Available
    - Corporate & High Volume: Available
  Example Workflow:
    Trigger: User completes a course.
    Condition: User is in 'New Customer' group.
    Action: Enroll user in 'Welcome Email Sequence' product.
```

--------------------------------

### LearnWorlds Actions: Tags

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Actions related to managing tags for users, including adding and removing tags based on various criteria.

```APIDOC
Actions - Tags:
  Add Tags
    Description: Adds one or more tags to a user.

  Add Tags based on User's Email Domain
    Description: Adds the domain name of the user's email as a tag. Only available when the Trigger 'User Signs-ups' is selected.

  Add User's Email Domain as a Tag
    Description: Adds the domain name of the user's email as a tag for specific email domains. Only available when the Trigger 'User Signs-ups' is selected.

  Add tags based on the user's TLD (.com, .org)
    Description: Add tags based on the TLD (e.g., .com, .org) of the user's email address.

  Remove Tags
    Description: Removes tags from the user.
```

--------------------------------

### Non-GDPR Compliant Script Example

Source: https://support.learnworlds.com/support/home/solutions/articles/12000051330-how-to-be-gdpr-compliant-using-javascript-code-snippets-scripts

This example shows a Javascript code snippet that is not GDPR compliant. It uses the default `type='text/javascript'` attribute, which means the script will execute regardless of user cookie consent.

```html
<script type="text/javascript">
  // Your non-GDPR compliant script here
</script>
```

--------------------------------

### User Provisioning and Login Flow

Source: https://support.learnworlds.com/support/home/solutions/articles/12000075025-how-to-use-auth0-with-learnworlds-saml-sso

Details on how new users are created and the overall login process when using SAML authentication with Auth0 and LearnWorlds.

```APIDOC
User Provisioning:
  - Create User: When enabled in LearnWorlds SAML settings, a new user account is automatically created in the school if a user with the provided email does not already exist.

Login Flow:
  - Users initiate login via Auth0.
  - Auth0 authenticates the user and sends a SAML assertion to LearnWorlds.
  - LearnWorlds validates the assertion using the provided certificate and logs the user in.

Disabling LearnWorlds Login:
  - To use Auth0 exclusively, disable the default LearnWorlds login/signup forms on:
    - Payment Flow settings (for logged-out users).
    - Payment Sections, 1-click Sales funnels, or Payment Pages.
```

--------------------------------

### Ebook Activity Creation and Configuration

Source: https://support.learnworlds.com/support/home/solutions/articles/12000003612-how-to-create-an-ebook-learning-activity-legacy-

Guides users through the process of adding an Ebook learning activity to a course, configuring its settings, and accessing the authoring panel. Covers essential settings like title, description, unit background, prerequisites, reading time estimation, and password protection.

```APIDOC
Feature: Ebook Learning Activity Management

Description: Manages the creation, configuration, and authoring of Ebook learning activities within a course.

Core Actions:
1.  **Create Ebook Activity**: Add a new Ebook activity to a course section.
    -   Steps: Navigate to Course -> Contents tab -> Add Activity -> Legacy Category -> Ebook (Legacy).
    -   Input: Activity title.
    -   Output: New Ebook activity instance.

2.  **Configure Ebook Settings**: Customize the properties of an existing Ebook activity.
    -   Access: Hover over the activity -> Click 'Settings'.
    -   Configurable Options:
        -   **Title**: Display title for the Ebook unit.
        -   **Description**: Brief description of the Ebook unit.
        -   **Icon**: Icon representing the Ebook unit.
        -   **Unit Background Image**: Custom background image for the unit.
        -   **Digital Download**: Link to associated digital download.
        -   **Prerequisite**: Set as a prerequisite for subsequent activities.
        -   **Reading Time**: Automatically calculated (180 words/min) or manually set estimated reading time.
        -   **Password Protection**: Secure the Ebook activity with a password.

3.  **Author Ebook Content**: Create and edit the content of the Ebook.
    -   Access: Hover over the activity -> Click 'Edit ebook' to open the Ebook authoring panel.
    -   Functionality:
        -   Utilize Ebook element library for content creation.
        -   Import content from MS Word files.
        -   Embed audio files (.mp3).
        -   Embed LearnWorlds videos.
    -   User Features:
        -   Keep notes and highlight text.

Related Features:
- Course Creation
- Course Sections
- Digital Downloads
- User Navigation and Completion Tracking
- Password Protection for Activities
```

--------------------------------

### GDPR Compliant Script Example

Source: https://support.learnworlds.com/support/home/solutions/articles/12000051330-how-to-be-gdpr-compliant-using-javascript-code-snippets-scripts

This example demonstrates how to add a Javascript code snippet for GDPR compliance. It requires setting `type='text/plain'` and adding the `data-accept-cookie` attribute with a specific privacy category like 'analytics', 'marketing', or 'functional'. The script will only execute if the user has consented to the specified cookie category.

```html
<script type="text/plain" data-accept-cookie="analytics">
  // Your GDPR compliant analytics script here
</script>
```

```html
<script type="text/plain" data-accept-cookie="marketing">
  // Your GDPR compliant marketing script here
</script>
```

```html
<script type="text/plain" data-accept-cookie="functional">
  // Your GDPR compliant functional script here
</script>
```

--------------------------------

### Calendly Group Session Integration Configuration

Source: https://support.learnworlds.com/support/home/solutions/articles/12000088796-how-to-create-a-group-session-learning-activity

This section details the configuration steps required to set up a Group Session learning activity in LearnWorlds, leveraging Calendly's Group Event functionality for scheduling. It outlines the prerequisites and the specific settings within LearnWorlds that connect to your Calendly setup.

```APIDOC
LearnWorlds Group Session Activity Setup:

Prerequisites:
  - A Calendly account with a plan that supports Group Events.
  - Calendly integration must be successfully set up within your LearnWorlds school (Integrations → Live Sessions → Calendly).
  - A Group Event Type must be created in your Calendly account.
    - When creating the Calendly Group Event Type:
      - Specify the maximum number of invitees allowed for the group meeting.
      - Optionally, configure whether to display remaining spots on the booking page.

LearnWorlds Activity Creation:
  1. Navigate to your course and select the 'Course outline' tab.
  2. Click 'Add an Activity'.
  3. Choose the 'Live session' tab and select 'Group session'.
  4. Click 'Save' or 'Save & Edit'.

LearnWorlds Activity Settings Configuration:
  - Title: Provide a title for the learning activity.
  - Description: Add a description for the learning activity.
  - Icon: Select an icon for the activity in the course player.
  - Account: Select the connected Calendly account.
  - Event Type: Choose the pre-configured Calendly Group Event Type from the dropdown. Only Group Calendly events will be listed.
  - Additional Settings (Optional):
    - Digital Downloads
    - Unit Background Image
    - Password Protection
```

--------------------------------

### LearnWorlds Actions: Communication

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Actions to send various forms of communication to users and collaborators.

```APIDOC
Actions - Communication:
  Send Email to User
    Description: Fires an email notification to the user. The notification template can be further edited.

  Send email to collaborators
    Description: Sends an email notification to collaborators. The notification template can be further edited.

  Send Push Notification (Mobile) to User
    Description: Fires a push notification to the mobile app for users who have downloaded the school's app.

  Send an Inbox Message to User
    Description: Sends a personalized message to the user's inbox within the school.

  Add to a Private Space
    Description: Adds the user to a private space in the Community.

  Remove from a Private Space
    Description: Removes the user from a private space in the Community.
```

--------------------------------

### Adding a Payment Section

Source: https://support.learnworlds.com/support/home/solutions/articles/12000030166-how-to-add-customize-and-optimize-your-payment-sections-in-learnworlds

Step-by-step instructions for adding a Payment Section to a page within the LearnWorlds website editor.

```APIDOC
Workflow: Add Payment Section

1. Navigate to Website -> Design -> Edit Website.
2. Access the Pages Manager to select the target page.
3. Click '+Add Section' and choose 'Payment Section'.
4. Click 'Save' to apply the changes.
```

--------------------------------

### Automation Triggers and Conditions

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Lists common triggers and conditions that can be used to initiate or filter automations. These define when an automation should run based on user actions or status within the LearnWorlds platform.

```APIDOC
Automation Triggers/Conditions:

Products:
- Is Enrolled to Course: Fires if the user is enrolled in a specific course.
- Is not Enrolled to Course: Fires if the user is not enrolled in a specific course.
- Is Enrolled to Bundle: Fires if the user is enrolled in a specific bundle.
- Is not Enrolled on Bundle: Fires if the user is not enrolled in a specific bundle.
- Owns Subscription: Fires if the user is enrolled in a specific subscription.
- Doesn't Own Subscription: Fires if the user is not subscribed to a specific subscription.

Responses:
- Form is Submitted: Fires if the user has submitted a response in a Marketing/Course Form.
- Assessment is Submitted: Fires if the user has submitted a graded/non-graded assessment.
- Assessment is Passed: Fires if the user has successfully passed the assessment.
- Assessment is Failed: Fires if the user has failed the assessment.
- Certificate Exam is submitted: Fires if the user submitted the certificate exam activity.
- Certificate Exam is passed: Fires if the user passed the certificate exam activity.
- Certificate Exam is failed: Fires if the user failed the certificate exam activity.
- Has Responded to NPS Form: Fires if the user has provided a response in the Net Promoter Score form.
- Has Responded to Qualification Form: Fires if the user has provided a response in the Qualification form.

General:
- Has accepted cookies: Fires only if the user has accepted the school's cookies, dependent on GDPR/cookie settings and user consent.
```

--------------------------------

### Custom HTML Code Example

Source: https://support.learnworlds.com/support/home/solutions/articles/12000077016-how-to-use-and-edit-the-section-layout-settings-of-page-sections

Illustrates how to access and modify the HTML code of a section for advanced customization. This requires understanding of HTML structure.

```HTML
<!-- Example of a custom HTML section -->
<div class="custom-section" style="background-color: #f0f0f0; padding: 20px;">
  <h2>Custom Content</h2>
  <p>This is a paragraph within a custom HTML section.</p>
  <button onclick="alert('Hello from custom HTML!');">Click Me</button>
</div>

<!-- After editing, ensure you click the 'Update' button to save changes. -->
```

--------------------------------

### SSO Sign-up and Password Reset Workflows

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080804-how-to-create-your-custom-sso-solution

Details the redirection parameters and steps for user sign-up and password reset when using a custom SSO solution with Learnworlds. This covers the parameters sent to the SSO provider and the expected flow.

```APIDOC
SSO_Workflow_Parameters:
  Description: Parameters used in redirects to the SSO provider for user authentication workflows.
  Workflows:
    - Sign-up:
        Trigger: User clicks 'Sign-up' and chooses Custom SSO.
        Redirect_URL_Parameters:
          - action: "signup"
          - redirectUrl: "<current page>"
        SSO_Provider_Action: Opens sign-up form, completes registration, and SSO's user to Learnworlds.
    - Password Reset:
        Trigger: User clicks 'Password Reset' button.
        Redirect_URL_Parameters:
          - action: "passwordreset"
          - redirectUrl: "<current page>"
        SSO_Provider_Action: Opens password reset form, completes workflow, and SSO's user to Learnworlds.
  Notes:
    - The 'redirectUrl' parameter specifies the page the user should be returned to after the SSO process is complete.
    - The 'action' parameter differentiates between the sign-up and password reset operations.
```

--------------------------------

### LearnWorlds Plan Feature Comparison for Roles

Source: https://support.learnworlds.com/support/home/solutions/articles/12000090243-learnworlds-team-onboarding-guide-roles-courses-reporting-more

Compares the availability of creating custom roles and assigning predefined roles across different LearnWorlds plans (Starter, Pro Trainer, Learning Center, High Volume). It also shows the limits on the number of Admins/Instructors/Reporters and User Group/Seat Managers per plan.

```APIDOC
Plan Feature Comparison:
  Feature | Starter | Pro Trainer | Learning Center | High Volume
  ---|---|---|---|---
  Create Custom Roles | ❌ | ❌ | ✔️ | ✔️
  Assign Predefined Roles | ❌ | ❌ | ✔️ | ✔️
  Admin/Instructor/Reporter Limit | 1 Admin | 5 Admins/Instructors | 25 Admins/Instructors/Reporters | Custom
  User Group/Seat Manager Limit | ❌ | ❌ | 10 | Custom

Notes:
  - Every LearnWorlds school must have at least one Admin account.
  - Other roles are optional based on the plan.
```

--------------------------------

### Conditional Script Import (HTML/Liquid)

Source: https://support.learnworlds.com/support/home/solutions/articles/12000082906-custom-code-case-examples

Imports a custom script specifically for the '/social' page. This demonstrates conditional rendering of script tags using Liquid.

```Liquid
{% if REQUEST.SLUG == "social" %}
    <!--Import custom script in social page-->
    <script type="text/javascript" src="https://www.mycdn.com/myscript.js"></script>
{% endif %}
```

--------------------------------

### APIDOC: Get Community Collections

Source: https://support.learnworlds.com/support/home/solutions/articles/12000017230-learnworlds-api-documentation

Retrieves a list of all community collections for the school. Collections are returned in sorted order, with the oldest created collections appearing first.

```APIDOC
GET https://api.learnworlds.com/v2/community/collections

Description:
  Returns a list of all community collections of the school.
  The community collections are in sorted order, with the oldest created collections appearing first.

Parameters:
  None

Returns:
  An array of community collection objects.
```

--------------------------------

### LearnWorlds SAML Configuration Parameters

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080825-how-to-set-up-sso-for-your-users-with-almost-any-identity-provider-using-saml-

Details the parameters required to configure SAML authentication within a LearnWorlds school. These parameters are provided by your Identity Provider (IDP) and entered into the LearnWorlds SAML setup page.

```APIDOC
SAML Configuration:

This section describes the parameters needed to set up SAML authentication in your LearnWorlds school.

1.  **IDP Identifier (Entity ID)**:
    *   Description: The unique identifier for your Identity Provider (IDP).
    *   Purpose: Used by the Service Provider (LearnWorlds) to identify the IDP.

2.  **Sign-on URL**:
    *   Description: The URL provided by the IDP that LearnWorlds will call to initiate the authentication process.
    *   Purpose: Redirects users to the IDP for authentication.

3.  **Single Logout URL**:
    *   Description: The URL provided by the IDP for handling single logout requests.
    *   Purpose: When a user logs out of LearnWorlds, this URL is called to log them out from other connected services via the IDP.

4.  **Identity Provider Certificate**:
    *   Description: The public certificate issued by the IDP.
    *   Purpose: Used by LearnWorlds to verify the authenticity of SAML assertions sent by the IDP.

5.  **Service Provider (SP) URL**:
    *   Description: Your school's SAML Service Provider (SP) URL.
    *   Purpose: The IDP uses this URL to identify your service (LearnWorlds).

6.  **Assertion Consumer Service (ACS) URL**:
    *   Description: The URL within your LearnWorlds school where the IDP sends the SAML assertion (authentication response).
    *   Purpose: Also known as the 'Reply URL', it informs your school if the user has been authenticated successfully.

7.  **Single Logout URL (SP)**:
    *   Description: The URL used by the IDP to inform the Service Provider (your school) about a user's logout.
    *   Purpose: Ensures that when a user logs out from the IDP, their session is also terminated in LearnWorlds.

8.  **Create User**:
    *   Description: A flag or setting to automatically create a new user in the school if they do not already exist upon successful SAML authentication.
    *   Purpose: Simplifies user onboarding for new users authenticating via SAML.
```

--------------------------------

### LearnWorlds Actions: Analytics

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Actions to send event data to various analytics platforms (Mixpanel, GA4, GTM, Meta).

```APIDOC
Actions - Analytics:
  Send Mixpanel event (BETA)
    Description: Sends an event to Mixpanel.

  Send GA4 event (BETA)
    Description: Sends an event to Google Analytics 4.

  Send GTM event (BETA)
    Description: Sends an event to Google Tag Manager.

  Send Meta event (BETA)
    Description: Sends an event to Meta (Facebook).
```

--------------------------------

### LearnWorlds Conditions: Opt-in

Source: https://support.learnworlds.com/support/home/solutions/articles/12000092545-how-to-set-up-user-automations

Conditions to filter automations based on user opt-in status for marketing emails.

```APIDOC
Conditions - Opt-in:
  Is Subscribed to Marketing Emails
    Description: Fires the automation only if the user has opted-in for marketing emails, according to GDPR settings.
```

--------------------------------

### LearnWorlds Custom SSO URL Parameters and Login Workflow

Source: https://support.learnworlds.com/support/home/solutions/articles/12000080804-how-to-create-your-custom-sso-solution

Details the URL parameters required by a custom SSO authentication page and outlines the step-by-step process for user login, including API interactions with LearnWorlds.

```APIDOC
URL Parameters for Custom SSO Page:

- **action**: Specifies the requested action. Possible values:
  - `login`: User authentication.
  - `signup`: User registration.
  - `password reset`: User password recovery.

- **redirectUrl**: The URL to redirect the user to after successful authentication. This parameter is URL-encoded and must be decoded before use.

Example URL: `http://www.example.com/sso-learnworlds?action=login&redirectUrl=https%3A%2F%2Fsoftomotive.getlearnworlds.com`

Login Workflow:

1. User initiates sign-in and selects the Custom SSO option.
2. LearnWorlds redirects the user to the SSO provider URL with `action=login` and the `redirectUrl` parameter.
3. The SSO provider displays a login form.
4. User enters credentials.
5. Upon successful authentication:
   a. The SSO provider uses the LearnWorlds SSO API method to log the user into the LearnWorlds school. This method also accepts the `redirectUrl` to direct the user back to the school.
      - API Reference: https://www.learnworlds.dev/docs/api/58052c1c3066e-single-sign-on
   b. The API returns a URL for redirecting the user's browser, automatically logging them in, and includes the LearnWorlds `user_id`.
   c. If the user is new, store the `user_id` in your system. Consider using the User Update API to add more user details.
      - API Reference: https://www.learnworlds.dev/docs/api/af37cf519afd1-update-a-user
6. The user is redirected back to the original page within the LearnWorlds school, now logged in.

Note: It is recommended to use the LearnWorlds `user_id` for existing SSO users, as email addresses may change in the SSO provider platform.
```

--------------------------------

### Disable Right-Click Context Menu (JavaScript)

Source: https://support.learnworlds.com/support/home/solutions/articles/12000082906-custom-code-case-examples

Prevents the default browser context menu from appearing when a user right-clicks on the page. This is achieved by intercepting the 'contextmenu' event.

```JavaScript
<script>
    // Disable right-click context menu
    window.addEventListener('contextmenu', function(event) {
      event.preventDefault();
    });
  </script>
```
Tokens:
Raw