Enrolments

The Enrolments Webhook delivers an enrolment payload any time when a user starts or completes a pathway and when their progress updates. The payload contains an array of enrolments in the data property, and each enrolment object contains the information on the user and their pathway status.

Payload Example

{
  "type": "enrolments",
  "data": {
    "pathway" : {
      "name": "Pathway Name",
      "ID": "FA-HCPG-06RF"
    }
    "enrolments": [
      {
        "email": "test@example.com",
        "firstname": "Test",
        "lastname": "User",
        "country": "South Africa",
        "city": "Cape Town",
        "status": {
          "level": 2,
          "state": "In Progress",
          "progress": 90,
          "version": "1.2.3",
          "timestamp": "2020-10-09T14:59:06+02:00"
          "joined": "2020-10-07T12:00:06+02:00"
        }
      },
      {
        "email": "test2@example",
        "firstname": "Test2",
        "lastname": "User",
        "country": "South Africa",
        "city": "Johannesburg",
        "status": {
          "level": 1,
          "state": "In Progress",
          "progress": 50,
          "version": "1.1.6",
          "timestamp": "2020-10-02T12:33:33+02:00",
          "joined": "2020-10-01T12:00:06+02:00"
        }
      },
      ...etc
    ]
  }
}

Payload Definitions

User Enrollment

Status

Last updated