{
"enrolment_id": 1841,
"org_id": 4,
"org_domain": "my_org",
"event": "enrolment_updated",
"enrolment_data": {
"account_id": 3516,
"user_name": "adam@example.com",
"email": "adam@example.com",
"first_name": "Adam",
"last_name": "Anderson",
"enrolled_date": "2024-04-09T09:39:16.688+10:00",
"due_date": null,
"updated_date": "2024-04-09T09:39:32.380+10:00",
"completed_date": "2024-04-09T09:39:32.353+10:00",
"certified_date": null,
"enrolled_by": "Manual enrolment by ",
"progress": "completed",
"status": "current",
"recertification_allowed": true,
"Color": "Blue",
"Car Model": "Hyundai;Audi",
"skills_attained": [
{
"skill_id": 8,
"skill_code": "COM",
"skill_name": "Compliance",
"skill_description": ""
},
{
"skill_id": 19,
"skill_code": "CPR",
"skill_name": "CPR 101",
"skill_description": "CPR training"
}
],
"enrolment_relationship": "Explorer",
"knowledge_type": "topic",
"knowledge_id": 278,
"knowledge_external_id": "123",
"knowledge_title": "Countries",
"length_minutes": 1,
"version": "1.0",
"certificate_id": "4-3516-1841",
"categories_continuing_education": [
{
"category_name": "HR",
"category_minutes": 0.5,
"category_points": "20.0"
}
],
"categories_all": "Sales, HR"
}
}Enrolment events
Enrolment updated
Sent when an existing enrolment’s dates change. It is sent only when:
- the due date changes on an enrolment that is not completed
- the completed date changes on an enrolment that was already completed
- the certified date is added or changed on a completed enrolment, other than when it is set as part of completing the enrolment
It is not sent when an enrolment is created, completed, deleted, reset or retaken. Those use the other events.
The event field is enrolment_updated. It is sent for both topic enrolments and pathway enrolments; enrolment_data.knowledge_type is topic or pathway.
See Webhooks for how to set up webhooks and delivery details.
WEBHOOK
https://your-webhook-url.example.com
enrolment-updated
{
"enrolment_id": 1841,
"org_id": 4,
"org_domain": "my_org",
"event": "enrolment_updated",
"enrolment_data": {
"account_id": 3516,
"user_name": "adam@example.com",
"email": "adam@example.com",
"first_name": "Adam",
"last_name": "Anderson",
"enrolled_date": "2024-04-09T09:39:16.688+10:00",
"due_date": null,
"updated_date": "2024-04-09T09:39:32.380+10:00",
"completed_date": "2024-04-09T09:39:32.353+10:00",
"certified_date": null,
"enrolled_by": "Manual enrolment by ",
"progress": "completed",
"status": "current",
"recertification_allowed": true,
"Color": "Blue",
"Car Model": "Hyundai;Audi",
"skills_attained": [
{
"skill_id": 8,
"skill_code": "COM",
"skill_name": "Compliance",
"skill_description": ""
},
{
"skill_id": 19,
"skill_code": "CPR",
"skill_name": "CPR 101",
"skill_description": "CPR training"
}
],
"enrolment_relationship": "Explorer",
"knowledge_type": "topic",
"knowledge_id": 278,
"knowledge_external_id": "123",
"knowledge_title": "Countries",
"length_minutes": 1,
"version": "1.0",
"certificate_id": "4-3516-1841",
"categories_continuing_education": [
{
"category_name": "HR",
"category_minutes": 0.5,
"category_points": "20.0"
}
],
"categories_all": "Sales, HR"
}
}Body
application/json
- Topic enrolment
- Pathway enrolment
ID of the topic or pathway enrolment
Your organisation's ID
Your organisation's subdomain
Show child attributes
Show child attributes
Response
2XX
Your endpoint should return a 2xx status code promptly.