LearnUpon Webhooks

https://docs.learnupon.com/webhooks
Admin
LearnUpon Webhooks is an API integration feature that enables developers to receive real-time event...
Tokens:11,600
Snippets:60
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Learning Path Completion Webhook Example

Source: https://docs.learnupon.com/webhooks

This JSON payload is sent when a learner completes a learning path. It includes user details, learning path information, course progress, and certification status.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "learning_path_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "learningPathUserId": 12345,
  "learningPathId": 12345,
  "learningPathName": "Webhooks 101",
  "courses": [{
    "id": 12345,
    "name": "Pre Test",
    "status": "passed",
    "percentage": 95
  }],
  "credits": [{
        "name": "cpd",
        "number": "11.0"
    },{
        "name": "cme",
        "number": "0.0"
    }
  ],
  "certification": true,
  "certificationName": "Webhook Certification 2015",
  "certExpiresAt": "2013-12-18T15:30:09Z",
  "wasRecertified": false,
  "dateEnrolled": "2012-12-16T15:30:09Z",
  "dateStarted": "2012-12-17T15:30:09Z",
  "dateCompleted": "2012-12-18T15:30:09Z",
  "percentage": 95,
  "numberCompletedCourses": 1
}

```

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

### Module Complete Webhook Example

Source: https://docs.learnupon.com/webhooks

This JSON payload is sent when a learner completes a module. It contains details about the course, user, and module completion status. This webhook is distinct from the course completion webhook.

```json
{
   "header" : {
      "webhookId" : 1721016,
      "lastAttemptAt" : "2022-12-13T16:34:16Z",
      "signature" : "no_secret_key_set",
      "source" : "LearnUpon",
      "webHookType" : "module_complete",
      "attempt" : 1,
      "version" : 1
   },
   "courseId" : 925689,
   "enrollmentId" : 15977495,
   "sequence" : 1,
   "dateStarted" : "2022-12-13 16:28:34 UTC",
   "userId" : 291235,
   "moduleId" : 747130,
   "percentage" : 100,
   "portalId" : 123456,
   "type" : "scorm",
   "markedComplete" : false,
   "additionalData" : null,
   "dateCompleted" : "2022-12-13 16:34:16 UTC",
   "status" : "passed"
}
```

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

### Learning Path Update Webhook Example

Source: https://docs.learnupon.com/webhooks

This JSON payload is sent when a learning path is updated. It contains details about the learning path but no user information. Ensure learning paths are published to trigger webhooks.

```json
{
   "header": {
      "source": "LearnUpon",
      "attempt": 1,
      "webHookType": "learning_path_updated",
      "signature": "453ace7ececfcbaa5647fc20d0e279a6",
      "version": 1,
      "lastAttemptAt": "2021-06-28T09:21:13Z",
      "webhookId": 249609
   },
   "learningPathId": 13550,
   "learningPathName": "Growing a positive company culture",
   "learningPathKeywords": "culture, growth, inclusion, business, company",
   "learningPathShortDescription": "In this learning path, we have organized a host of courses which best showcase growing a positive company culture.",
   "learningPathStatus": "Published",
   "cataloged": true,
   "learningPathLength": 45,
   "learningPathLengthUnit": "Minutes",
   "thumbnailImageUrl": "https://s3.eu-west-1.amazonaws.com/learnupon/lpimages/16597/large/teams.jpeg",
   "difficulty": "Not Applicable"
}

```

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

### Example Webhook JSON Payload

Source: https://docs.learnupon.com/webhooks

This is a typical JSON structure for a webhook payload, containing header metadata and user information. Ensure your server can parse this format.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "course_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  }

}
```

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

### Exam Submitted Webhook Example

Source: https://docs.learnupon.com/webhooks

This JSON payload is sent when a learner submits an exam. It includes details about the user, course, exam, and the learner's performance. This webhook signifies that a learner has completed an exam.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "exam_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "enrollmentId": 12345,
  "courseId": 12345,
  "courseName": "Webhooks 101",
  "courseReferenceCode": "XYZ123",
  "examId": 12345,
  "examName": "Pre Test",
  "isKnowledgeTest": false,
  "status": "passed",
  "percentage": 95,
  "dateCompleted": "2012-12-18T15:30:09Z",
  "attemptsTaken": 2,
  "attemptsAllowed": null,
  "unlimitedAttemptsAllowed": true,
  "timedExam": true,
  "timeAllowed": 60,
  "timeTaken": 867.03,
  "wasAutoSubmitted": false,
  "passMark": null,
  "passPercentage": 90
}
```

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

### Badge Revoked Webhook Example

Source: https://docs.learnupon.com/webhooks

This JSON payload represents a badge revoked event. It includes details about the user, the badge, and webhook metadata. Use this structure to process badge revocations in your application.

```json
{
   "header" : {
      "source" : "LearnUpon",
      "version" : 1,
      "webhookId" : 10033124,
      "attempt" : 2,
      "lastAttemptAt" : "2019-12-16T22:32:13Z",
      "webHookType" : "badge_revoked",
      "signature" : "b1acfe18b94803bb06c6a8e62140723b"
   },
   "user" : {
      "id" : 6138780,
      "lastName" : "test1",
      "firstName" : "test1",
      "email" : "test1@luptest.com",
      "username" : null,
      "numberOfPoints" : 5,
      "numberOfBadges" : 2
   },
   "badge" : {
      "id" : 104601,
      "name" : "Bronze Course Completion",
      "points" : 20
   }
}
```

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

### Purchase Completion Webhook Sample

Source: https://docs.learnupon.com/webhooks

This JSON payload represents a webhook triggered upon a successful bulk purchase in LearnUpon's eCommerce module. It includes details about the user, order, payment, and line items.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "purchase_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "orderId": 1234,
  "currency": "usd",
  "country": "United States",
  "state": "California",
  "paymentGateway": "stripe",
  "paymentId": "jh_CHRHKeugje",
  "discount": null,
  "coupon": null,
  "dateCompleted": "2012-12-18T15:30:09Z",
  "bulkCodes": "JGUHT353, JFHHHGYEHEH, JHJGHEF78",
  "orderTotal": 33.00,
  "amountPaid": 33.00,
  "orderDiscount": 1.00,
  "salesTaxAmount": 1.00,
  "lineItems": [
    {
      "lineItemId": 1353,
      "name": "JSON For Developers",
      "courseReferenceCode": "json_123",
      "type": "course",
      "listPrice": 11.00,
      "discount": 1.00,
      "coupon": "LEARNUPONJSON",
      "salesTaxRate": 10,
      "salesTaxAmount": 1.00,
      "taxRateLocation": "store",
      "amountPaid": 11.00,
      "quantity": 1
    }
  ]
}
```

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

### Responding to a Webhook

Source: https://docs.learnupon.com/webhooks

To successfully acknowledge a webhook, your server must return a 2xx HTTP status code within 2 seconds. Any other response code indicates failure, and LearnUpon will retry sending the webhook.

```APIDOC
## Responding to a Webhook

### Description
Your server should return a **2xx HTTP status code** to acknowledge successful receipt of the webhook. LearnUpon's system ignores any other information in the request headers or body.

### Response Codes
- **2xx**: Indicates successful receipt and processing.
- **4xx**: Indicates a client error, and LearnUpon will log a response in the Error Message section.
- **Other codes**: Indicate failure, prompting LearnUpon to retry sending the webhook for up to 2 hours.

### Response Time
Responses must be no longer than 2 seconds. Exceeding this limit will cause a timeout and mark the hook as failed. If processing takes longer, return a status code first and then complete the processing in a background process or after closing the connection.
```

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

### Course Clone Completion Webhook

Source: https://docs.learnupon.com/webhooks

This webhook is triggered when a course is successfully cloned in LearnUpon. It provides details about the source and destination portals, as well as the original and new course IDs.

```APIDOC
## Course Clone Completion Webhook

### Description
This webhook is a JSON payload sent to your designated URL endpoint whenever LearnUpon successfully clones, aka makes a copy of, a course, from either the user interface or by using the API.

### Method
POST

### Endpoint
`/websites/learnupon_webhooks/course_clone_completion`

### Request Body
- **header** (object) - Information about the webhook event.
  - **source** (string) - The source system of the webhook (e.g., "LearnUpon").
  - **version** (integer) - The version of the webhook payload.
  - **webhookId** (integer) - The unique identifier for this webhook event.
  - **attempt** (integer) - The number of times this webhook has been attempted.
  - **lastAttemptAt** (string) - The timestamp of the last attempt.
  - **webHookType** (string) - The type of webhook, "course_cloning_complete".
  - **signature** (string) - A signature for webhook verification.
- **clonedFromPortalId** (integer) - Source portal of the original course.
- **clonedToPortalId** (integer) - Destination portal for the new cloned course.
- **newCourseId** (integer) - The course ID for the newly cloned course.
- **originalCourseId** (integer) - The course ID for the original course.
- **ownerId** (integer) - Unique identifier of the course owner.

### Request Example
```json
{
    "header": {
        "source": "LearnUpon",
        "version": 1,
        "webhookId": 178134,
        "attempt": 2,
        "lastAttemptAt": "2022-03-07T18:36:02Z",
        "webHookType": "course_cloning_complete",
        "signature": "6d8275f37584e888167c40e100abffcd"
    },
    "clonedFromPortalId": 2000,
    "clonedToPortalId": 15001,
    "newCourseId": 126002,
    "originalCourseId": 126000,
    "ownerId": 1341
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the webhook processing.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Module Complete Webhook

Source: https://docs.learnupon.com/webhooks

This webhook is sent when a learner completes a module. It contains details about the module, course, and enrollment.

```APIDOC
## Module Complete Webhook

### Description
This webhook is a JSON payload of completion data sent to your designated URL endpoint, every time a learner completes a module. This webhook is different from the course completion webhook, that contains module data. For exam and survey modules, LearnUpon sends both the `exam_completion` or `survey_completion` and the `module_complete` webhook. This webhook handles ILT Center training differently from legacy ILT modules: ILT Center training sessions are "conditional scorable" and can generate a `failed` status; legacy ILT modules never generate a `failed` status.

### Method
POST

### Endpoint
`/websites/learnupon_webhooks`

### Request Body
- **header** (object) - Required - Header information for the webhook.
  - **webhookId** (integer) - Required - Unique identifier for the webhook.
  - **lastAttemptAt** (string) - Required - Timestamp of the last attempt.
  - **signature** (string) - Required - Signature for webhook verification.
  - **source** (string) - Required - Source of the webhook (e.g., "LearnUpon").
  - **webHookType** (string) - Required - Type of webhook (e.g., "module_complete").
  - **attempt** (integer) - Required - The attempt number.
  - **version** (integer) - Required - Version of the webhook.
- **courseId** (integer) - Required - Unique numeric identifier for the course.
- **enrollmentId** (integer) - Required - Unique numeric identifier for the enrollment.
- **sequence** (integer) - Required - Order of the module within the course.
- **dateStarted** (string) - Required - The date and time (UTC) the learner started the module.
- **userId** (integer) - Required - Unique numeric identifier for the user.
- **moduleId** (integer) - Required - Unique numeric identifier for the module completed.
- **percentage** (integer) - Required - The percentage of the module completed.
- **portalId** (integer) - Required - Unique numeric identifier for your portal.
- **type** (string) - Required - Type of module completed (e.g., `page`, `exam`, `scorm`).
- **markedComplete** (boolean) - Optional - Indicates if completion was marked manually.
- **additionalData** (object) - Optional - Reserved for future development (currently `Null`).
- **dateCompleted** (string) - Required - The date and time (UTC) the learner completed the module.
- **status** (string) - Required - Status of the learner on the module (e.g., `completed`, `failed`).

### Request Example
```json
{
   "header" : {
      "webhookId" : 1721016,
      "lastAttemptAt" : "2022-12-13T16:34:16Z",
      "signature" : "no_secret_key_set",
      "source" : "LearnUpon",
      "webHookType" : "module_complete",
      "attempt" : 1,
      "version" : 1
   },
   "courseId" : 925689,
   "enrollmentId" : 15977495,
   "sequence" : 1,
   "dateStarted" : "2022-12-13 16:28:34 UTC",
   "userId" : 291235,
   "moduleId" : 747130,
   "percentage" : 100,
   "portalId" : 123456,
   "type" : "scorm",
   "markedComplete" : false,
   "additionalData" : null,
   "dateCompleted" : "2012-12-13 16:34:16 UTC",
   "status" : "passed"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Webhook received successfully"
}
```
```

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

### Webhook HTTP Headers

Source: https://docs.learnupon.com/webhooks

LearnUpon webhooks include custom HTTP headers that provide additional information about the webhook.

```APIDOC
## HTTP Headers

### Description
Each webhook sent by LearnUpon includes custom HTTP headers that provide metadata about the webhook.

### Headers
- **X-Powered-By** (string): Indicates the source, set to `LearnUpon` for all webhooks.
- **X-LearnUpon-Version** (string): The version of the webhook API source.
- **X-LearnUpon-TimeStamp** (string): The Unix Epoch Time when LearnUpon servers generated the webhook.
```

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

### Sample Course Update Webhook Payload

Source: https://docs.learnupon.com/webhooks

This JSON payload represents the data sent when a course is updated. It includes comprehensive details about the course, its modules, pricing, and other attributes. This webhook is triggered for published, under revision, archived, or deleted courses.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "webhookId": 16011,
    "attempt": 2,
    "lastAttemptAt": "2020-02-26T14:52:29Z",
    "webHookType": "course_updated",
    "signature": "453ace7ececfcbaa5647fc20d0e279a6"
  },
  "courseId": 14874,
  "courseName": "Health and Safety 101",
  "courseReferenceCode": "HS101",
  "courseKeywords": "health and safety, health, safety",
  "courseShortDescription": "Occupational safety and health (OSH), also commonly referred to as occupational health and safety (OHS), occupational health, or workplace health and safety (WHS), is a multidisciplinary field concerned with the safety, health, and welfare of people at work. These terms also refer to the goals of this field, so their use in the sense of this article was originally an abbreviation of occupational safety and health program/department etc.\n\nThe goals of occupational safety and health programs include to foster a safe and healthy work environment. OSH may also protect co-workers, family members, employers, customers, and many others who might be affected by the workplace environment.",
  "datePublished": "2019-06-17T16:31:56Z",
  "courseVersion": 1,
  "courseSourceId": 14874,
  "courseStatus": "Published",
  "cataloged": true,
  "thumbnailImageUrl": "https://s3.eu-west-1.amazonaws.com/learnupondev/courseimages/1293/large/pixel77-free-vector-medical-logo-0512-400.jpg",
  "difficulty": "Basic",
  "courseLength": 30,
  "courseLengthUnit": "Minutes",
  "modules": [
    {
      "id": 17925,
      "type": "Module",
      "name": "Health and Safety Video Tutorial",
      "isKnowledgeCheck": false
    },
    {
      "id": 17926,
      "type": "Exam",
      "name": "Health and Safety Knowledge Check",
      "isKnowledgeCheck": true
    }
  ],
  "courseIsSellable": true,
  "price": 0,
  "membershipPricing": [
    {
      "name": "memberPrice",
      "price": 40
    },
    {
      "name": "nonMemberPrice",
      "price": 100
    }
  ],
  "dueDate": {
    "numOfDaysAfterEnrollment": null,
    "setDate": null
  },
  "accessExpires": {
    "numOfDaysAfterEnrollment": null,
    "setDate": null
  },
  "certificate": {
    "certificateName": "Health and Safety 101",
    "certExpiresNumDaysAfterAward": 365,
    "autoReenroll": true,
    "autoReenrollNumDaysBeforeCertExpires": 300
  },
  "credits": [
    {
      "name": "CPE",
      "number": "100.0"
    }
  ],
  "badges": [
    {
      "name": "Gold Course Completion",
      "number": 2,
      "points": 80,
      "achieved": "On course completion"
    },
    {
      "name": "Strong Skills",
      "number": 2,
      "points": 80,
      "achieved": "On course completion"
    }
  ]
}
```

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

### Course Completion Webhook

Source: https://docs.learnupon.com/webhooks

This webhook is triggered when a learner completes a course. It provides comprehensive details about the user, course, enrollment, and completion status.

```APIDOC
## Course Completion Webhook

### Description
This webhook is a JSON payload of completion data sent to your designated URL endpoint, every time a learner completes a course. This webhook's details about modules are **different** from the module completion webhook.

### Method
POST

### Endpoint
`/websites/learnupon_webhooks/course_completion`

### Request Body
- **header** (object) - Information about the webhook event.
  - **source** (string) - The source system of the webhook (e.g., "LearnUpon").
  - **version** (integer) - The version of the webhook payload.
  - **signature** (string) - A signature for webhook verification.
  - **webhookId** (integer) - The unique identifier for this webhook event.
  - **attempt** (integer) - The number of times this webhook has been attempted.
  - **lastAttemptAt** (string) - The timestamp of the last attempt.
  - **webHookType** (string) - The type of webhook, "course_completion".
- **user** (object) - Information about the user completing the course.
  - **userId** (integer) - The unique identifier for the user.
  - **lastName** (string) - The last name of the user.
  - **firstName** (string) - The first name of the user.
  - **email** (string) - The email address of the user.
  - **username** (string) - The username of the user.
  - **customData** (object) - Custom data associated with the user.
    - **customerId** (integer) - Example custom data field.
- **enrollmentId** (integer) - The unique identifier for the enrollment.
- **courseId** (integer) - The unique identifier for the course.
- **courseName** (string) - The name of the course.
- **courseReferenceCode** (string) - The reference code for the course.
- **modules** (array) - An array of module completion details.
  - **id** (integer) - The module ID.
  - **name** (string) - The module name.
  - **type** (string) - The module type.
  - **status** (string) - The completion status of the module.
  - **percentage** (integer) - The completion percentage for the module.
- **credits** (array) - An array of credit information.
  - **name** (string) - The name of the credit.
  - **number** (string) - The number of credits.
- **certification** (boolean) - Indicates if a certification was awarded.
- **certificationName** (string) - The name of the certification.
- **certExpiresAt** (string) - The expiration date of the certification.
- **wasRecertified** (boolean) - Indicates if the certification was recertified.
- **courseAccessExpiresAt** (string) - The expiration date of course access (can be null).
- **dateEnrolled** (string) - The date the user was enrolled.
- **dateStarted** (string) - The date the user started the course.
- **dateCompleted** (string) - The date the user completed the course.
- **enrollmentStatus** (string) - The overall enrollment status.
- **percentage** (integer) - The overall course completion percentage.
- **hasAttemptsRemaining** (boolean) - Indicates if there are attempts remaining.
- **manuallyMarkedComplete** (boolean) - Indicates if the course was manually marked complete.
- **manuallyMarkedCompleteById** (integer) - The ID of the user who manually marked it complete.

### Request Example
```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "course_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "enrollmentId": 12345,
  "courseId": 12345,
  "courseName": "Webhooks 101",
  "courseReferenceCode": "XYZ123",
  "modules": [
    {
        "id": 12345,
        "name": "Pre Test",
        "type": "exam",
        "status": "passed",
        "percentage": 95
    }
  ],
  "credits": [
    {
        "name": "cpd",
        "number": "11.0"
    },
    {
        "name": "cme",
        "number": "0.0"
    }
  ],
  "certification": true,
  "certificationName": "Webhook Certification 2015",
  "certExpiresAt": "2013-12-18T15:30:09Z",
  "wasRecertified": false,
  "courseAccessExpiresAt": null,
  "dateEnrolled": "2012-12-16T15:30:09Z",
  "dateStarted": "2012-12-17T15:30:09Z",
  "dateCompleted": "2012-12-18T15:30:09Z",
  "enrollmentStatus": "passed",
  "percentage": 95,
  "hasAttemptsRemaining": false,
  "manuallyMarkedComplete": true,
  "manuallyMarkedCompleteById": 11
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the webhook processing.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Webhook Content Structure

Source: https://docs.learnupon.com/webhooks

A typical webhook payload includes a header section with metadata and a user section detailing the user who triggered the event.

```APIDOC
## Webhook Content

### Description
Webhooks contain a JSON body with a `header` and `user` section. The `header` contains metadata about the webhook, while the `user` section describes the user who triggered the event (if applicable).

### JSON Payload Example
```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "course_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  }
}
```

### Header Attributes
- **source** (string): Indicates the source of the webhook, typically `LearnUpon`.
- **version** (integer): The API version for the webhook.
- **signature** (string): An MD5 Hash of the JSON data (excluding the signature itself) used for verifying data integrity. This is optional but recommended.
- **webhookId** (integer): A unique identifier for the webhook event.
- **attempt** (integer): The number of times LearnUpon has attempted to send this webhook.
- **lastAttemptAt** (date/time): The timestamp of the last failed attempt to send the webhook in UTC format.
- **webHookType** (string): Specifies the type of event that triggered the webhook (e.g., `course_completion`).

### User Attributes
- **userId** (integer): The unique numeric identifier for the user.
- **lastName** (string): The last name of the user.
- **firstName** (string): The first name of the user.
- **email** (string): The email address of the user, often used as a unique identifier.
- **username** (string): The username of the user, if implemented as a unique identifier.
- **customData** (object): An object containing any custom user data fields configured in LearnUpon.
```

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

### Calculate MD5 Hash for Webhook Verification in Ruby

Source: https://docs.learnupon.com/webhooks

Use this Ruby code to calculate the MD5 hash for verifying webhook signatures. Ensure your JSON parser does not alter whitespace and that the secret key is appended correctly with a colon separator.

```ruby
MD5.hexdigest( JSON_DATA_FROM_HOOK + ":" + secret_key )
```

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

### Course Clone Completion Webhook Payload

Source: https://docs.learnupon.com/webhooks

This JSON payload is sent when a course is successfully cloned. It includes details about the source and destination portals, as well as the original and new course IDs.

```json
{
    "header": {
        "source": "LearnUpon",
        "version": 1,
        "webhookId": 178134,
        "attempt": 2,
        "lastAttemptAt": "2022-03-07T18:36:02Z",
        "webHookType": "course_cloning_complete",
        "signature": "6d8275f37584e888167c40e100abffcd"
    },
    "clonedFromPortalId": 2000,
    "clonedToPortalId": 15001,
    "newCourseId": 126002,
    "originalCourseId": 126000,
    "ownerId": 1341
}
```

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

### Course Completion Webhook Payload

Source: https://docs.learnupon.com/webhooks

This JSON payload is sent when a learner completes a course. It contains comprehensive details about the user, enrollment, course, and completion status, including module-specific information.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "course_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "enrollmentId": 12345,
  "courseId": 12345,
  "courseName": "Webhooks 101",
  "courseReferenceCode": "XYZ123",
  "modules": [
        {
            "id": 12345,
            "name": "Pre Test",
            "type": "exam",
            "status": "passed",
            "percentage": 95
        }
  ],
  "credits": [
            {
                "name": "cpd",
                "number": "11.0"
            },
            {
                "name": "cme",
                "number": "0.0"
            }
   ],
  "certification": true,
  "certificationName": "Webhook Certification 2015",
  "certExpiresAt": "2013-12-18T15:30:09Z",
  "wasRecertified": false,
  "courseAccessExpiresAt": null,
  "dateEnrolled": "2012-12-16T15:30:09Z",
  "dateStarted": "2012-12-17T15:30:09Z",
  "dateCompleted": "2012-12-18T15:30:09Z",
  "enrollmentStatus": "passed",
  "percentage": 95,
  "hasAttemptsRemaining": false,
  "manuallyMarkedComplete": true,
  "manuallyMarkedCompleteById": 11
}
```

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

### Exam Submitted Webhook

Source: https://docs.learnupon.com/webhooks

This webhook is sent when a learner submits an exam. It includes details about the exam, user, and course.

```APIDOC
## Exam Submitted Webhook

### Description
This webhook is a JSON payload of exam submitted details. Submitting an exam indicates that a learner completed an exam.

### Method
POST

### Endpoint
`/websites/learnupon_webhooks`

### Request Body
- **header** (object) - Required - Header information for the webhook.
  - **source** (string) - Required - Source of the webhook (e.g., "LearnUpon").
  - **version** (integer) - Required - Version of the webhook.
  - **signature** (string) - Required - Signature for webhook verification.
  - **webhookId** (integer) - Required - Unique identifier for the webhook.
  - **attempt** (integer) - Required - The attempt number.
  - **lastAttemptAt** (string) - Required - Timestamp of the last attempt.
  - **webHookType** (string) - Required - Type of webhook (e.g., "exam_completion").
- **user** (object) - Required - Information about the user.
  - **userId** (integer) - Required - Unique numeric identifier for the user.
  - **lastName** (string) - Required - Last name of the user.
  - **firstName** (string) - Required - First name of the user.
  - **email** (string) - Required - Email address of the user.
  - **username** (string) - Required - Username of the user.
  - **customData** (object) - Optional - Custom data associated with the user.
    - **customerId** (integer) - Required - Customer ID.
- **enrollmentId** (integer) - Required - Unique numeric identifier for the enrollment.
- **courseId** (integer) - Required - Unique numeric identifier for the course.
- **courseName** (string) - Required - Name of the course.
- **courseReferenceCode** (string) - Required - Reference code for the course.
- **examId** (integer) - Required - Unique numeric identifier for the exam.
- **examName** (string) - Required - Name of the exam.
- **isKnowledgeTest** (boolean) - Required - Indicates if it's a knowledge test.
- **status** (string) - Required - Status of the exam submission (e.g., "passed").
- **percentage** (integer) - Required - Percentage score achieved.
- **dateCompleted** (string) - Required - The date and time (UTC) the exam was completed.
- **attemptsTaken** (integer) - Required - Number of attempts taken.
- **attemptsAllowed** (integer) - Optional - Maximum number of attempts allowed (null if unlimited).
- **unlimitedAttemptsAllowed** (boolean) - Required - Indicates if unlimited attempts are allowed.
- **timedExam** (boolean) - Required - Indicates if the exam was timed.
- **timeAllowed** (integer) - Optional - Time allowed for the exam in minutes.
- **timeTaken** (float) - Optional - Time taken to complete the exam in seconds.
- **wasAutoSubmitted** (boolean) - Required - Indicates if the exam was auto-submitted.
- **passMark** (integer) - Optional - The pass mark for the exam (null if not applicable).
- **passPercentage** (integer) - Required - The pass percentage for the exam.

### Request Example
```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "exam_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "enrollmentId": 12345,
  "courseId": 12345,
  "courseName": "Webhooks 101",
  "courseReferenceCode": "XYZ123",
  "examId": 12345,
  "examName": "Pre Test",
  "isKnowledgeTest": false,
  "status": "passed",
  "percentage": 95,
  "dateCompleted": "2012-12-18T15:30:09Z",
  "attemptsTaken": 2,
  "attemptsAllowed": null,
  "unlimitedAttemptsAllowed": true,
  "timedExam": true,
  "timeAllowed": 60,
  "timeTaken": 867.03,
  "wasAutoSubmitted": false,
  "passMark": null,
  "passPercentage": 90
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Webhook received successfully"
}
```
```

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

### Badge Awarded Webhook Payload

Source: https://docs.learnupon.com/webhooks

This is a sample JSON payload for a badge awarded webhook. It includes details about the user, the badge awarded, and the context of the award.

```json
{
   "header" : {
      "source" : "LearnUpon",
      "version" : 1,
      "webhookId" : 10033043,
      "attempt" : 2,
      "lastAttemptAt" : "2019-12-16T22:24:20Z",
      "webHookType" : "badge_awarded",
      "signature" : "5819cb303fd80d4f3d1d6a6ea7608b68"
   },
   "user" : {
      "id" : 6138780,
      "lastName" : "test1",
      "firstName" : "test1",
      "email" : "test1@luptest.com",
      "username" : null,
      "numberOfPoints" : 25,
      "numberOfBadges" : 3
   },
   "badge" : {
      "id" : 104597,
      "points" : 0,
      "name" : "Level 1 novice badge"
   },
   "awardedBy" : {
      "gamificationLevel" : {
         "id" : 29011,
         "achievedOverOrEqual" : 0,
         "name" : "Level 1"
      }
   }
}
```

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

### Survey Submitted Webhook Payload

Source: https://docs.learnupon.com/webhooks

This JSON payload represents the data sent when a user completes a survey within a course. It includes details about the user, course, and survey.

```json
{
  "header": {
    "source": "LearnUpon",
    "version": 1,
    "signature": "6d8275f37584e888167c40e100abffcd",
    "webhookId": 1234,
    "attempt": 1,
    "lastAttemptAt": "2012-12-18T15:30:09Z",
    "webHookType": "survey_completion"
  },
  "user": {
    "userId": 12,
    "lastName": "Doe",
    "firstName": "John",
    "email": "john.doe@somewhere.com",
    "username": "john.doe",
    "customData": {
        "customerId": 124124
    }
  },
  "enrollmentId": 12345,
  "courseId": 12345,
  "courseName": "Webhooks 101",
  "courseReferenceCode": "XYZ123",
  "surveyId": 123456,
  "surveyName": "Pre Test",
  "dateCompleted": "2012-12-18T15:30:09Z"
}
```
Tokens:
Raw