Webhook Payloads

Northpass currently supports the following webhook notifications. To easily navigate to an individual webhook payload, see the "Table of Contents" on the right-hand side of your screen. πŸ‘‰

πŸ“˜

Note

Many of the below webhooks are dependent on specific authentication types. For more information about the authentication options available within Northpass, please see this support article.

Learner Created

This webhook is sent whenever a learner account is created.

  • For academies using Open Access, this occurs whenever a unique learner logs in on the /auth/.../login page.

  • For academies using Preregistration, this occurs whenever a new learner account is created (via UI or API)

{
   "data":{
      "id":"11111111-1111-1111-1111-111111111111",
      "type":"learner_created_events",
      "links":{},
      "included":[
         {
            "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type":"people",
            "links":{
               "self":"https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "teaching":"https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
            },
            "attributes":{
               "name":"Jill Smith",
               "email":"[email protected]",
               "sso_uid":"[email protected]",
               "full_name":"Jill Smith",
               "created_at":"2022-04-08T17:55:42Z",
               "first_name":"Jill",
               "updated_at":"2022-04-08T17:55:42Z",
               "activated_at":"2022-04-08T17:55:42Z",
               "unsubscribed":false
            },
            "relationships":{
               "school":{
                  "data":{
                     "id":"00000000-0000-0000-0000-000000000000",
                     "type":"schools"
                  }
               }
            }
         }
      ],
      "attributes":{
         "created_at":"2022-04-08T17:55:43Z"
      },
      "relationships":{
         "person":{
            "data":{
               "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "type":"people"
            }
         }
      }
   }
}

Person Invited

This webhook is sent whenever a learner is invited to an academy that uses preregistration. Additionally, when admin and/or manager accounts are created, this webhook will also send.

{
   "data":{
      "id":"222222222-2222-2222-2222-222222222222",
      "type":"learner_created_events",
      "links":{},
      "included":[
         {
            "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type":"people",
            "links":{
               "self":"https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "teaching":"https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
            },
            "attributes":{
               "email":"[email protected]",
               "created_at":"2022-05-03T12:18:28Z",
               "updated_at":"2022-05-03T12:18:28Z",
               "unsubscribed":false
            },
            "relationships":{
               "school":{
                  "data":{
                     "id":"00000000-0000-0000-0000-000000000000",
                     "type":"schools"
                  }
               }
            }
         }
      ],
      "attributes":{
         "created_at":"2022-05-03T12:18:29Z"
      },
      "relationships":{
         "person":{
            "data":{
               "id":"2847b677-b661-4d27-a33e-08901d91b95a",
               "type":"people"
            }
         }
      }
   }
}

Person Activated

This webhook is sent whenever a user (admin, manager, or learner) activates their academy account.

  • For academies using Open Access, this occurs whenever a unique learner logs in (for the first time) on the /auth/.../login page.

  • For academies using Preregistration, this occurs whenever a new learner account invitation is accepted and a password is set.

{
   "data":{
      "id":"333333333-3333-3333-3333-333333333333",
      "type":"person_activated_events",
      "links":{
         
      },
      "included":[
         {
            "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type":"people",
            "links":{
               "self":"https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "teaching":"https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
            },
            "attributes":{
               "name":"Jill Smith",
               "email":"[email protected]",
               "sso_uid":"[email protected]",
               "full_name":"Jill Smith",
               "created_at":"2022-04-08T17:55:42Z",
               "first_name":"Jill",
               "updated_at":"2022-04-08T17:55:42Z",
               "activated_at":"2022-04-08T17:55:42Z",
               "unsubscribed":false
            },
            "relationships":{
               "school":{
                  "data":{
                     "id":"00000000-0000-0000-0000-000000000000",
                     "type":"schools"
                  }
               }
            }
         }
      ],
      "attributes":{
         "created_at":"2022-04-08T17:55:43Z"
      },
      "relationships":{
         "person":{
            "data":{
               "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "type":"people"
            }
         }
      }
   }
}

Learner Enrolled in Course

This webhook is sent whenever a learner gets enrolled in any course in an academy.

{
    "data": {
        "id": "77777777-7777-7777-7777-777777777777",
        "type": "learner_enrolled_to_course_events",
        "links": {},
        "included": [
            {
                "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                "type": "people",
                "links": {
                    "self": "https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "teaching": "https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
                },
                "attributes": {
                    "name": "Jill Smith",
                    "email": "[email protected]",
                    "sso_uid": "[email protected]",
                    "full_name": "Jill Smith",
                    "created_at": "2022-04-08T17:55:42Z",
                    "first_name": "Jill",
                  	"last_name": "Smith",
                    "updated_at": "2022-04-08T17:55:42Z",
                    "activated_at": "2022-04-08T17:55:42Z",
                    "unsubscribed": false,
                    "last_active_at": "2022-04-08T17:58:47Z"
                },
                "relationships": {
                    "school": {
                        "data": {
                            "id": "00000000-0000-0000-0000-000000000000",
                            "type": "schools"
                        }
                    }
                }
            },
            {
                "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                "type": "courses",
                "links": {
                    "self": "https://api.northpass.com/v2/courses/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                    "build": {
                        "href": "https://app.northpass.com/courses/abcdefgh/builder",
                        "methods": [
                            "get"
                        ]
                    },
                    "clone": "https://app.northpass.com/courses/abcdefgh/clone",
                    "preview": "/previews/courses/abcdefgh",
                    "teaching": "https://app.northpass.com/courses/abcdefgh"
                },
                "attributes": {
                    "name": "Onboarding 101",
                    "status": "live",
                    "for_sale": true,
                    "permalink": "abcdefgh",
                    "created_at": "2020-09-01T16:36:33Z",
                    "updated_at": "2022-04-08T17:58:37Z",
                    "enrollments_count": 2215,
                    "share_course_link": "https://subdomain.northpass.com/outline/abcdefgh/cover",
                    "course_enrollment_link": "https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
                },
                "relationships": {
                    "categories": {
                        "data": []
                    },
                    "instructor_partnerships": {
                        "data": []
                    }
                }
            }
        ],
        "attributes": {
            "created_at": "2023-02-28T18:09:02Z"
        },
        "relationships": {
            "course": {
                "data": {
                    "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
                    "type": "courses"
                }
            },
            "person": {
                "data": {
                    "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "type": "people"
                }
            }
        }
    }
}

Learner Started Course

This webhook gets sent whenever a learner clicks the Start Course button in an academy. This webhook will also send when a learner restarts, or retakes, a course.

{
    "data": {
        "id": "88888888-8888-8888-8888-888888888888",
        "type": "learner_started_course_events",
        "links": {},
        "included": [
            {
                "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                "type": "people",
                "links": {
                    "self": "https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "teaching": "https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
                },
                "attributes": {
                    "name": "Jill Smith",
                    "email": "[email protected]",
                    "sso_uid": "[email protected]",
                    "full_name": "Jill Smith",
                    "created_at": "2022-04-08T17:55:42Z",
                    "first_name": "Jill",
                    "last_name": "Smith",
                    "updated_at": "2022-04-08T17:55:42Z",
                    "activated_at": "2022-04-08T17:55:42Z",
                    "unsubscribed": false,
                    "last_active_at": "2022-04-08T17:58:47Z"
                },
                "relationships": {
                    "school": {
                        "data": {
                            "id": "00000000-0000-0000-0000-000000000000",
                            "type": "schools"
                        }
                    }
                }
            },
            {
                "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                "type": "courses",
                "links": {
                    "self": "https://api.northpass.com/v2/courses/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                    "build": {
                        "href": "https://app.northpass.com/courses/abcdefgh/builder",
                        "methods": [
                            "get"
                        ]
                    },
                    "clone": "https://app.northpass.com/courses/abcdefgh/clone",
                    "preview": "/previews/courses/abcdefgh",
                    "teaching": "https://app.northpass.com/courses/abcdefgh"
                },
                "attributes": {
                    "name": "Onboarding 101",
                    "status": "live",
                    "for_sale": true,
                    "permalink": "abcdefgh",
                    "created_at": "2020-09-01T16:36:33Z",
                    "updated_at": "2022-04-08T17:58:37Z",
                    "enrollments_count": 2215,
                    "share_course_link": "https://subdomain.northpass.com/outline/abcdefgh/cover",
                    "course_enrollment_link": "https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
                },
                "relationships": {
                    "categories": {
                        "data": []
                    },
                    "instructor_partnerships": {
                        "data": []
                    }
                }
            }
        ],
        "attributes": {
            "created_at": "2023-02-28T18:09:07Z",
            "course_version": 6,
            "course_attempt_number": 1
        },
        "relationships": {
            "course": {
                "data": {
                    "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
                    "type": "courses"
                }
            },
            "person": {
                "data": {
                    "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "type": "people"
                }
            }
        }
    }
}

Learner Completed Activity

This webhooks is sent whenever a learner completes any activity in any course.

{
   "data":{
      "id":"44444444-4444-4444-4444-444444444444",
      "type":"activity_completed_events",
      "links":{},
      "included":[
         {
            "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type":"people",
            "links":{
               "self":"https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "teaching":"https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
            },
"attributes":{
               "name":"Jill Smith",
               "email":"[email protected]",
               "sso_uid":"[email protected]",
               "full_name":"Jill Smith",
               "created_at":"2022-04-08T17:55:42Z",
               "first_name":"Jill",
               "updated_at":"2022-04-08T17:55:42Z",
               "activated_at":"2022-04-08T17:55:42Z",
               "unsubscribed":false,
               "last_active_at":"2022-04-08T17:58:47Z"
            },
            "relationships":{
               "school":{
                  "data":{
                     "id":"00000000-0000-0000-0000-000000000000",
                     "type":"schools"
                  }
               }
            }
         },
         {
            "id":"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
            "type":"courses",
            "links":{
               "self":"https://api.northpass.com/v2/courses/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
               "build":{
                  "href":"https://app.northpass.com/courses/abcdefgh/builder",
                  "methods":[
                     "get"
                  ]
               },
               "clone":"https://app.northpass.com/courses/abcdefgh/clone",
               "preview":"/previews/courses/abcdefgh",
               "teaching":"https://app.northpass.com/courses/abcdefgh"
            },
            "attributes":{
               "name":"Onboarding 101",
               "status":"live",
               "for_sale":true,
               "permalink":"abcdefgh",
               "created_at":"2020-09-01T16:36:33Z",
               "updated_at":"2022-04-08T17:58:37Z",
               "list_image_url":"Image URL here",
               "enrollments_count":2215,
               "share_course_link":"https://subdomain.northpass.com/outline/abcdefgh/cover",
               "course_enrollment_link":"https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
            },
            "relationships":{
               "categories":{
                  "data":[]
               },
               "instructor_partnerships":{
                  "data":[]
               }
            }
         },
         {
            "id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "type":"activities",
            "links":{
               "teaching":"https://app.northpass.com/courses/abcdefgh/builder/activities/ijklmnop",
               "course_builder":"https://app.northpass.com/courses/abcdefgh/builder"
            },
            "attributes":{
               "title":"Getting Started",
               "course_name":"Onboarding 101"
            }
         }
      ],
      "attributes":{
         "value":12,	//this represents the learners progress (%) through the course
         "created_at":"2022-04-08T17:58:49Z",
         "course_attempt_number":1
      },
      "relationships":{
         "course":{
            "data":{
               "id":"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
               "type":"courses"
            }
         },
         "person":{
            "data":{
               "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "type":"people"
            }
         },
         "activity":{
            "data":{
               "id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
               "type":"activities"
            }
         }
      }
   }
}

Learner Completed Quiz

This webhook is sent whenever a learner completes a quiz in any course.

{
   "data":{
      "id":"55555555-5555-5555-5555-555555555555",
      "type":"quiz_completed_events",
      "included":[
         {
            "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type":"people",
            "links":{
               "self":"https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "teaching":"https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
            },
					"attributes":{
               "name":"Jill Smith",
               "email":"[email protected]",
               "sso_uid":"[email protected]",
               "full_name":"Jill Smith",
               "created_at":"2022-04-08T17:55:42Z",
               "first_name":"Jill",
               "updated_at":"2022-04-08T17:55:42Z",
               "activated_at":"2022-04-08T17:55:42Z",
               "unsubscribed":false,
               "last_active_at":"2022-04-08T17:58:47Z"
            },
            "relationships":{
               "school":{
                  "data":{
                     "id":"00000000-0000-0000-0000-000000000000",
                     "type":"schools"
                  }
               }
            }
         },
         {
            "id":"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
            "type":"courses",
            "links":{
               "self":"https://api.northpass.com/v2/courses/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
               "build":{
                  "href":"https://app.northpass.com/courses/abcdefgh/builder",
                  "methods":[
                     "get"
                  ]
               },
               "clone":"https://app.northpass.com/courses/abcdefgh/clone",
               "preview":"/previews/courses/abcdefgh",
               "teaching":"https://app.northpass.com/courses/abcdefgh"
            },
            "attributes":{
               "name":"Onboarding 101",
               "status":"live",
               "for_sale":true,
               "permalink":"abcdefgh",
               "created_at":"2020-09-01T16:36:33Z",
               "updated_at":"2022-04-08T17:58:37Z",
               "enrollments_count":2215,
               "share_course_link":"https://subdomain.northpass.com/outline/abcdefgh/cover",
               "course_enrollment_link":"https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
            },
            "relationships":{
               "categories":{
                  "data":[]
               },
               "instructor_partnerships":{
                  "data":[]
               }
            }
         },
         {
            "id":"yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
            "type":"activities",
            "links":{
               "teaching":"https://app.northpass.com/courses/abcdefgh/builder/activities/rstuvwxyz",
               "course_builder":"https://app.northpass.com/courses/abcdefgh/builder"
            },
            "attributes":{
               "title":"Quiz Activity",
               "course_name":"Onboarding 101"
            }
         },
         {
            "id":"wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww",
            "type":"quizzes",
            "links":{
               "self":{
                  "href":"https://api.northpass.com/v1/quizzes/wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww",
                  "methods":[
                     "delete"
                  ]
               },
               "build":"https://app.northpass.com/quizzes/1234567/builder",
               "analytics":"https://app.northpass.com/analytics/single_quiz_results.wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww"
            },
            "attributes":{
               "name":"Quiz Name",
               "quiz_type":"Quizzes::Static",
               "created_at":"2022-11-27T17:41:23Z"
            },
            "relationships":{
               "person":{
                  "data":{
                     "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                     "type":"people"
                  }
               },
               "activities":{
                  "data":[
                     {
                        "id":"yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
                        "type":"activities"
                     }
                  ]
               }
            }
         }
      ],
      "attributes":{
         "value":100,
         "created_at":"2022-05-03T12:23:25Z",
         "quiz_attempt_uuid":"vvvvvvvv-vvvv-vvvv-vvvv-vvvvvvvvvvvv",
         "attempts_remaining":0,
         "minimum_passing_score":80
      },
      "relationships":{
         "quiz":{
            "data":{
               "id":"wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww",
               "type":"activities"
            }
         },
         "course":{
            "data":{
               "id":"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
               "type":"courses"
            }
         },
         "person":{
            "data":{
               "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "type":"people"
            }
         },
         "activity":{
            "data":{
               "id":"yyyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
               "type":"activities"
            }
         }
      }
   }
}

Learner Completed Course

This webhook is sent whenever a learner completes any course in an academy.

{
   "data":{
      "id":"66666666-6666-6666-6666-666666666666",
      "type":"course_completed_events",
      "links":{
         
      },
      "included":[
         {
            "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type":"people",
            "links":{
               "self":"https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "teaching":"https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
            },
			   "attributes":{
               "name":"Jill Smith",
               "email":"[email protected]",
               "sso_uid":"[email protected]",
               "full_name":"Jill Smith",
               "created_at":"2022-04-08T17:55:42Z",
               "first_name":"Jill",
               "updated_at":"2022-04-08T17:55:42Z",
               "activated_at":"2022-04-08T17:55:42Z",
               "unsubscribed":false,
               "last_active_at":"2022-04-08T17:58:47Z"
            },
            "relationships":{
               "school":{
                  "data":{
                     "id":"00000000-0000-0000-0000-000000000000",
                     "type":"schools"
                  }
               }
            }
         },
         {
            "id":"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
            "type":"courses",
            "links":{
               "self":"https://api.northpass.com/v2/courses/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
               "build":{
                  "href":"https://app.northpass.com/courses/abcdefgh/builder",
                  "methods":[
                     "get"
                  ]
               },
               "clone":"https://app.northpass.com/courses/abcdefgh/clone",
               "preview":"/previews/courses/abcdefgh",
               "teaching":"https://app.northpass.com/courses/abcdefgh"
            },
            "attributes":{
               "name":"Onboarding 101",
               "status":"live",
               "for_sale":true,
               "permalink":"abcdefgh",
               "created_at":"2020-09-01T16:36:33Z",
               "updated_at":"2022-04-08T17:58:37Z",
               "list_image_url":"Image URL here",
               "enrollments_count":2215,
               "share_course_link":"https://subdomain.northpass.com/outline/abcdefgh/cover",
               "course_enrollment_link":"https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
            },
            "relationships":{
               "categories":{
                  "data":[]
               },
               "instructor_partnerships":{
                  "data":[]
               }
            }
         }
      ],
      "attributes":{
         "created_at":"2022-05-03T12:51:02Z",
         "course_version":4,
         "course_attempt_number":1
      },
      "relationships":{
         "course":{
            "data":{
               "id":"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
               "type":"courses"
            }
         },
         "person":{
            "data":{
               "id":"abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "type":"people"
            }
         }
      }
   }
}

Learner Registered for ILT Session

This webhook is sent whenever a learner successfully registers for an Instructor-Led Training (ILT) session.

{
    "data": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "learner_registered_to_ilt_session_events",
      "links": {},
      "included": [
        {
          "id": "11111111-1111-1111-1111-111111111111",
          "type": "people",
          "links": {
            "self": "https://api.northpass.com/v1/people/11111111-1111-1111-1111-111111111111",
            "teaching": "https://app.northpass.com/people/11111111-1111-1111-1111-111111111111"
          },
          "attributes": {
            "name": "Sally Sales",
            "email": "[email protected]",
            "sso_uid": "[email protected]",
            "full_name": "Sally Sales",
            "last_name": "Sales",
            "created_at": "2023-11-21T13:56:12Z",
            "first_name": "Sally",
            "updated_at": "2023-11-21T13:56:13Z",
            "activated_at": "2023-11-21T13:56:12Z",
            "unsubscribed": false
          },
          "relationships": {
            "school": {
              "data": {
                "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaa",
                "type": "schools"
              }
            }
          }
        },
        {
          "id": "cccccccc-cccc-cccc-cccccccccccc",
          "type": "training_sessions",
          "links": {
            "self": "https://app.northpass.com/instructor_led_trainings/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/training_sessions",
            "analytics": "https://app.northpass.com/analytics/instructor_led_trainings",
            "manage_attendance": "https://app.northpass.com/instructor_led_trainings/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/training_sessions/cccccccc-cccc-cccc-cccccccccccc/manage_attendances"
          },
          "attributes": {
            "title": "01/15/24 @ 9:00 am - 9:45 am",
            "ends_at": "2024-01-15T09:45:00Z",
            "starts_at": "2024-01-15T09:00:00Z",
            "session_url": "www.webinarjoinlinkhere.com",
            "seats_available": 150,
            "training_session_registrations_count": 13
          },
          "relationships": {
            "training_event": {
              "data": {
                "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
                "type": "training_events"
              }
            },
            "instructor_partnership": {
              "data": {
                "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzzz",
                "type": "people"
              }
            }
          }
        },
        {
          "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
          "type": "training_events",
          "links": {
            "edit": "https://app.northpass.com/instructor_led_trainings/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/edit",
            "sessions": "https://api.northpass.com/v2/training_events/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/training_sessions",
            "teaching": "https://app.northpass.com/instructor_led_trainings/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
            "notifications": "https://api.northpass.com/v2/training_events/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/notification_schedules"
          },
          "attributes": {
            "title": "Webinar Title",
            "status": "upcoming",
            "time_zone": "America/New_York",
            "created_at": "2023-07-01T12:36:09Z",
            "event_type": "online",
            "updated_at": "2023-07-01T12:36:09Z",
            "visibility": "all",
            "description": "<p>Rich text description</p>",
            "next_session": "2024-02-15T06:00:00.000Z",
            "session_count": 3,
            "registration_type": "individual",
            "notification_count": 1
          },
          "relationships": {
            "groups": {
              "data": []
            },
            "courses": {
              "data": []
            }
          }
        }
      ],
      "attributes": {
        "created_at": "2023-11-21T13:56:22Z"
      },
      "relationships": {
        "person": {
          "data": {
            "id": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
            "type": "people"
          }
        },
        "training_event": {
          "data": {
            "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
            "type": "training_events"
          }
        },
        "training_session": {
          "data": {
            "id": "cccccccc-cccc-cccc-cccccccccccc",
            "type": "training_sessions"
          }
        }
      }
    }
  }
  

Learner Enrolled in Learning Path

This webhook is sent whenever a learner gets enrolled in a Learning Path.

/* ENROLLED IN PATH */

{
    "data": {
        "id": "77777777-7777-7777-7777-777777777777",
        "type": "learner_enrolled_to_learning_path_events",
        "links": {},
        "included": [
            {
                "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                "type": "people",
                "links": {
                    "self": "https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "teaching": "https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
                },
                "attributes": {
                    "name": "Jill Smith",
                    "email": "[email protected]",
                    "sso_uid": "[email protected]",
                    "full_name": "Jill Smith",
                    "created_at": "2022-04-08T17:55:42Z",
                    "first_name": "Jill",
                    "last_name": "Smith",
                    "updated_at": "2022-04-08T17:55:42Z",
                    "activated_at": "2022-04-08T17:55:42Z",
                    "unsubscribed": false,
                    "last_active_at": "2022-04-08T17:58:47Z"
                },
                "relationships": {
                    "school": {
                        "data": {
                            "id": "00000000-0000-0000-0000-000000000000",
                            "type": "schools"
                        }
                    }
                }
            },
            {
                "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                "type": "learning_paths",
                "links": {
                    "self": "https://api.northpass.com/v2/learning_paths/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz"
                },
                "attributes": {
                    "name": "Onboarding 101",
                    "created_at": "2020-09-01T16:36:33Z",
                    "updated_at": "2022-04-08T17:58:37Z",
                    "share_course_link": "https://subdomain.northpass.com/app/learning_paths/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                    "learning_parth_enrollment_link": "https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
                },
                "relationships": {
                    "instructor_partnerships": {
                        "data": []
                    }
                }
            }
        ],
        "attributes": {
            "created_at": "2023-02-28T18:09:02Z"
        },
        "relationships": {
            "learning_path": {
                "data": {
                    "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
                    "type": "learning_paths"
                }
            },
            "person": {
                "data": {
                    "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "type": "people"
                }
            }
        }
    }
}

Learner Starts Learning Path

This webhook is sent whenever a learner starts a Learning Path.

{
   "data": {
      "id": "88888888-8888-8888-8888-888888888888",
      "type": "learning_path_started_events",
      "links": {},
      "included": [
         {
            "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
            "type": "people",
            "links": {
               "self": "https://api.northpass-staging.com/v1/people/3dde1769-32a1-4523-909b-1a2566cd30b1",
               "teaching": "https://app.northpass-staging.com/people/3dde1769-32a1-4523-909b-1a2566cd30b1"
            },
            "attributes": {
               "name": "Jill Smith",
               "email": "[email protected]",
               "sso_uid": "[email protected]",
               "full_name": "Jill Smith",
               "created_at": "2022-04-08T17:55:42Z",
               "first_name": "Jill",
               "last_name": "Smith",
               "updated_at": "2022-04-08T17:55:42Z",
               "activated_at": "2022-04-08T17:55:42Z",
               "unsubscribed": false
            },
            "relationships": {
               "school": {
                  "data": {
                     "id": "00000000-0000-0000-0000-000000000000",
                     "type": "schools"
                  }
               }
            }
         },
         {
            "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
            "type": "learning_paths",
            "links": {
               "edit": "https://app.northpass.com/learning_paths/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz/summary",
               "self": "https://api.northpass.com/v1/learning_paths/abcdefgh"
            },
            "attributes": {
               "name": "Onboarding 101",
               "uuid": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
               "created_at": "2023-07-28T13:37:05Z",
               "share_learning_path_link": "https://subdomain.northpass.com/learning_paths/abcdefgh/cover",
               "learning_path_enrollment_link": "https://subdomain.northpass.com/p/abcdefghijklmnopqrstuvwxyz"
            }
         }
      ],
      "attributes": {
         "created_at": "2023-07-28T13:42:31Z",
         "attempt_number": 1
      },
      "relationships": {
         "person": {
            "data": {
               "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
               "type": "people"
            }
         },
         "learning_path": {
            "data": {
               "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
               "type": "learning_paths"
            }
         }
      }
   }
}

Learner Completed Learning Path Item

This webhook is sent whenever a learner completes any

/* COMPLETED PATH ITEM */
{
    "data": {
        "id": "99999999-9999-9999-9999-999999999999",
        "type": "learning_path_item_completed_events",
        "links": {},
        "included": [
            {
                "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                "type": "people",
                "links": {
                    "self": "https://api.northpass.com/v2/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "teaching": "https://app.northpass.com/people/abcdefghi-1234-jklm-5678-nopqrstuvwxy"
                },
                "attributes": {
                    "name": "Jill Smith",
                    "email": "[email protected]",
                    "sso_uid": "[email protected]",
                    "full_name": "Jill Smith",
                    "created_at": "2022-04-08T17:55:42Z",
                    "first_name": "Jill",
                    "updated_at": "2022-04-08T17:55:42Z",
                    "activated_at": "2022-04-08T17:55:42Z",
                    "unsubscribed": false,
                    "last_active_at": "2022-04-08T17:58:47Z"
                },
                "relationships": {
                    "school": {
                        "data": {
                            "id": "00000000-0000-0000-0000-000000000000",
                            "type": "schools"
                        }
                    }
                }
            },
            {
                "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                "type": "learning_paths",
                "links": {
                    "edit": "https://app.northpass.com/learning_paths/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz/summary",
                    "self": "https://api.northpass.com/v1/learning_paths/abcdefgh"
                },
                "attributes": {
                    "name": "Onboarding 101",
                    "uuid": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                    "created_at": "2023-07-28T13:37:05Z",
                    "share_learning_path_link": "https://subdomain.northpass.com/learning_paths/abcdefgh/cover",
                    "learning_path_enrollment_link": "https://subdomain.northpass.com/p/abcdefghijklmnopqrstuvwxyz"
                }
            },
            {
                "id": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
                "type": "courses",
                "links": {
                    "self": "https://api.northpass.com/v1/courses/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
                    "build": {
                        "href": "https://app.northpass.com/courses/12345678/builder",
                        "methods": [
                            "get"
                        ]
                    },
                    "clone": "https://app.northpass.com/courses/12345678/clone",
                    "preview": "/previews/courses/12345678",
                    "teaching": "https://app.northpass.com/courses/12345678"
                },
                "attributes": {
                    "name": "Introduction Course",
                    "status": "live",
                    "permalink": "12345678",
                    "created_at": "2023-02-24T17:32:46Z",
                    "updated_at": "2023-07-28T19:36:22Z",
                    "enrollments_count": 2,
                    "share_course_link": "https://subdomain.northpass.com/outline/12345678/cover",
                    "course_enrollment_link": "https://subdomain.northpass.com/c/abcdefghijklmnopqrstuvwxyz"
                },
                "relationships": {
                    "instructor_partnerships": {
                        "data": []
                    }
                }
            }
        ],
        "attributes": {
            "value": 75, // this value indiciates the learner's progress against all required items in the learning path
            "created_at": "2023-07-28T19:41:48Z",
            "attempt_number": 1
        },
        "relationships": {
            "item": {
                "data": {
                    "id": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
                    "type": "courses"
                }
            },
            "person": {
                "data": {
                    "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "type": "people"
                }
            },
            "learning_path": {
                "data": {
                    "id": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
                    "type": "learning_paths"
                }
            }
        }
    }
}

Learner Completed Learning Path

This webhook is sent whenever a learner completes all of the required content in a learning path.

/* COMPLETED PATH */
{
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "learning_path_completed_events",
        "links": {},
        "included": [
            {
                "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                "type": "people",
                "links": {
                    "self": "https://api.northpass-staging.com/v1/people/3dde1769-32a1-4523-909b-1a2566cd30b1",
                    "teaching": "https://app.northpass-staging.com/people/3dde1769-32a1-4523-909b-1a2566cd30b1"
                },
                "attributes": {
                    "name": "Jill Smith",
                    "email": "[email protected]",
                    "sso_uid": "[email protected]",
                    "full_name": "Jill Smith",
                    "created_at": "2022-04-08T17:55:42Z",
                    "first_name": "Jill",
                    "last_name": "Smith",
                    "updated_at": "2022-04-08T17:55:42Z",
                    "activated_at": "2022-04-08T17:55:42Z",
                    "unsubscribed": false
                },
                "relationships": {
                    "school": {
                        "data": {
                            "id": "00000000-0000-0000-0000-000000000000",
                            "type": "schools"
                        }
                    }
                }
            },
            {
                "id": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
                "type": "learning_paths",
                "links": {
                    "edit": "https://app.northpass.com/learning_paths/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz/summary",
                    "self": "https://api.northpass.com/v1/learning_paths/abcdefgh"
                },
                "attributes": {
                    "name": "Onboarding 101",
                    "uuid": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzz",
                    "created_at": "2023-07-28T13:37:05Z",
                    "share_learning_path_link": "https://subdomain.northpass.com/learning_paths/abcdefgh/cover",
                    "learning_path_enrollment_link": "https://subdomain.northpass.com/p/abcdefghijklmnopqrstuvwxyz"
                }
            }
        ],
        "attributes": {
            "created_at": "2023-07-28T13:42:31Z",
            "attempt_number": 1
        },
        "relationships": {
            "person": {
                "data": {
                    "id": "abcdefghi-1234-jklm-5678-nopqrstuvwxy",
                    "type": "people"
                }
            },
            "learning_path": {
                "data": {
                    "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
                    "type": "learning_paths"
                }
            }
        }
    }
}