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 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"
            }
         }
      }
   }
}

Quiz Completed

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"
            }
         }
      }
   }
}

Did this page help you?